aws-sdk-quicksight 1.16.0 → 1.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd22fde69017c17ae0dff2c1af5053d5515d4d08
-  data.tar.gz: 73d2b0f1102a8374c2954f6bc9f1419b782dc115
+  metadata.gz: 4c38ce2f48d8fb5ab1ce40146f8d785eb561ac71
+  data.tar.gz: d8a6ea917615112080612d7d0a9106534eb54b08
 SHA512:
-  metadata.gz: 6e7d3c9eb0c4ce1024159f3c65ad048dd79018cb6833f107aa1375cad97f8862b40dbe41d894eac7e02d33c5da6040db61006f534c0acf17691731351a015ccb
-  data.tar.gz: cc98fbe1bef3a189ba9f45404634e4b15338b75193e7a0fc8c53268793596693fa006413d6a8f8a89020645f46bf24bbdc49fdf68b375018153bf888434912a8
+  metadata.gz: 5e749b7eb81156d04642249c39994f0a85e57e356c3abaccc0a5a48dfe72a72b7d69d6e08597648559c6084ab338fe965189b32ecc77c1dbd2fbd8a5816f378d
+  data.tar.gz: cd51eb3d432de8a8a235bba006daf452fac08e47813cd8fbf2c1f600e0258bd86fb0047e9b9ffc0bcb4ccefec12b02be92bef80b25b43c49086df5237d4e6d21

data/lib/aws-sdk-quicksight.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-quicksight/customizations'
 # @service
 module Aws::QuickSight
 
-  GEM_VERSION = '1.16.0'
+  GEM_VERSION = '1.17.1'
 
 end

data/lib/aws-sdk-quicksight/client.rb

@@ -3415,6 +3415,70 @@ module Aws::QuickSight
       req.send_request(options)
     end
 
+    # Searchs for dashboards that belong to a user.
+    #
+    # @option params [required, String] :aws_account_id
+    #   The ID of the AWS account that contains the user whose dashboards
+    #   you're searching for.
+    #
+    # @option params [required, Array<Types::DashboardSearchFilter>] :filters
+    #   The filters to apply to the search. Currently, you can search only by
+    #   user name. For example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
+    #   "Operator": "StringEquals", "Value":
+    #   "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results, or null if there are no more
+    #   results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to be returned per request.
+    #
+    # @return [Types::SearchDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SearchDashboardsResponse#dashboard_summary_list #dashboard_summary_list} => Array&lt;Types::DashboardSummary&gt;
+    #   * {Types::SearchDashboardsResponse#next_token #next_token} => String
+    #   * {Types::SearchDashboardsResponse#status #status} => Integer
+    #   * {Types::SearchDashboardsResponse#request_id #request_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.search_dashboards({
+    #     aws_account_id: "AwsAccountId", # required
+    #     filters: [ # required
+    #       {
+    #         operator: "StringEquals", # required, accepts StringEquals
+    #         name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
+    #         value: "String",
+    #       },
+    #     ],
+    #     next_token: "String",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.dashboard_summary_list #=> Array
+    #   resp.dashboard_summary_list[0].arn #=> String
+    #   resp.dashboard_summary_list[0].dashboard_id #=> String
+    #   resp.dashboard_summary_list[0].name #=> String
+    #   resp.dashboard_summary_list[0].created_time #=> Time
+    #   resp.dashboard_summary_list[0].last_updated_time #=> Time
+    #   resp.dashboard_summary_list[0].published_version_number #=> Integer
+    #   resp.dashboard_summary_list[0].last_published_time #=> Time
+    #   resp.next_token #=> String
+    #   resp.status #=> Integer
+    #   resp.request_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboards AWS API Documentation
+    #
+    # @overload search_dashboards(params = {})
+    # @param [Hash] params ({})
+    def search_dashboards(params = {}, options = {})
+      req = build_request(:search_dashboards, params)
+      req.send_request(options)
+    end
+
     # Assigns one or more tags (key-value pairs) to the specified QuickSight
     # resource.
     #
@@ -4587,7 +4651,7 @@ module Aws::QuickSight
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-quicksight'
-      context[:gem_version] = '1.16.0'
+      context[:gem_version] = '1.17.1'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-quicksight/client_api.rb

@@ -77,8 +77,11 @@ module Aws::QuickSight
     DashboardError = Shapes::StructureShape.new(name: 'DashboardError')
     DashboardErrorList = Shapes::ListShape.new(name: 'DashboardErrorList')
     DashboardErrorType = Shapes::StringShape.new(name: 'DashboardErrorType')
+    DashboardFilterAttribute = Shapes::StringShape.new(name: 'DashboardFilterAttribute')
     DashboardName = Shapes::StringShape.new(name: 'DashboardName')
     DashboardPublishOptions = Shapes::StructureShape.new(name: 'DashboardPublishOptions')
+    DashboardSearchFilter = Shapes::StructureShape.new(name: 'DashboardSearchFilter')
+    DashboardSearchFilterList = Shapes::ListShape.new(name: 'DashboardSearchFilterList')
     DashboardSourceEntity = Shapes::StructureShape.new(name: 'DashboardSourceEntity')
     DashboardSourceTemplate = Shapes::StructureShape.new(name: 'DashboardSourceTemplate')
     DashboardSummary = Shapes::StructureShape.new(name: 'DashboardSummary')
@@ -167,6 +170,7 @@ module Aws::QuickSight
     Expression = Shapes::StringShape.new(name: 'Expression')
     FileFormat = Shapes::StringShape.new(name: 'FileFormat')
     FilterOperation = Shapes::StructureShape.new(name: 'FilterOperation')
+    FilterOperator = Shapes::StringShape.new(name: 'FilterOperator')
     GeoSpatialColumnGroup = Shapes::StructureShape.new(name: 'GeoSpatialColumnGroup')
     GeoSpatialCountryCode = Shapes::StringShape.new(name: 'GeoSpatialCountryCode')
     GeoSpatialDataRole = Shapes::StringShape.new(name: 'GeoSpatialDataRole')
@@ -298,6 +302,8 @@ module Aws::QuickSight
     S3Key = Shapes::StringShape.new(name: 'S3Key')
     S3Parameters = Shapes::StructureShape.new(name: 'S3Parameters')
     S3Source = Shapes::StructureShape.new(name: 'S3Source')
+    SearchDashboardsRequest = Shapes::StructureShape.new(name: 'SearchDashboardsRequest')
+    SearchDashboardsResponse = Shapes::StructureShape.new(name: 'SearchDashboardsResponse')
     ServiceNowParameters = Shapes::StructureShape.new(name: 'ServiceNowParameters')
     SessionLifetimeInMinutes = Shapes::IntegerShape.new(name: 'SessionLifetimeInMinutes')
     SessionLifetimeInMinutesInvalidException = Shapes::StructureShape.new(name: 'SessionLifetimeInMinutesInvalidException')
@@ -656,6 +662,13 @@ module Aws::QuickSight
     DashboardPublishOptions.add_member(:sheet_controls_option, Shapes::ShapeRef.new(shape: SheetControlsOption, location_name: "SheetControlsOption"))
     DashboardPublishOptions.struct_class = Types::DashboardPublishOptions
 
+    DashboardSearchFilter.add_member(:operator, Shapes::ShapeRef.new(shape: FilterOperator, required: true, location_name: "Operator"))
+    DashboardSearchFilter.add_member(:name, Shapes::ShapeRef.new(shape: DashboardFilterAttribute, location_name: "Name"))
+    DashboardSearchFilter.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "Value"))
+    DashboardSearchFilter.struct_class = Types::DashboardSearchFilter
+
+    DashboardSearchFilterList.member = Shapes::ShapeRef.new(shape: DashboardSearchFilter)
+
     DashboardSourceEntity.add_member(:source_template, Shapes::ShapeRef.new(shape: DashboardSourceTemplate, location_name: "SourceTemplate"))
     DashboardSourceEntity.struct_class = Types::DashboardSourceEntity
 
@@ -1472,6 +1485,18 @@ module Aws::QuickSight
     S3Source.add_member(:input_columns, Shapes::ShapeRef.new(shape: InputColumnList, required: true, location_name: "InputColumns"))
     S3Source.struct_class = Types::S3Source
 
+    SearchDashboardsRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
+    SearchDashboardsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: DashboardSearchFilterList, required: true, location_name: "Filters"))
+    SearchDashboardsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
+    SearchDashboardsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+    SearchDashboardsRequest.struct_class = Types::SearchDashboardsRequest
+
+    SearchDashboardsResponse.add_member(:dashboard_summary_list, Shapes::ShapeRef.new(shape: DashboardSummaryList, location_name: "DashboardSummaryList"))
+    SearchDashboardsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
+    SearchDashboardsResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
+    SearchDashboardsResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
+    SearchDashboardsResponse.struct_class = Types::SearchDashboardsResponse
+
     ServiceNowParameters.add_member(:site_base_url, Shapes::ShapeRef.new(shape: SiteBaseUrl, required: true, location_name: "SiteBaseUrl"))
     ServiceNowParameters.struct_class = Types::ServiceNowParameters
 
@@ -2609,6 +2634,26 @@ module Aws::QuickSight
         o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
       end)
 
+      api.add_operation(:search_dashboards, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "SearchDashboards"
+        o.http_method = "POST"
+        o.http_request_uri = "/accounts/{AwsAccountId}/search/dashboards"
+        o.input = Shapes::ShapeRef.new(shape: SearchDashboardsRequest)
+        o.output = Shapes::ShapeRef.new(shape: SearchDashboardsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
+        o.errors << Shapes::ShapeRef.new(shape: UnsupportedUserEditionException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
         o.name = "TagResource"
         o.http_method = "POST"

data/lib/aws-sdk-quicksight/types.rb

@@ -1768,6 +1768,42 @@ module Aws::QuickSight
       include Aws::Structure
     end
 
+    # A filter that you apply when searching for dashboards.
+    #
+    # @note When making an API call, you may pass DashboardSearchFilter
+    #   data as a hash:
+    #
+    #       {
+    #         operator: "StringEquals", # required, accepts StringEquals
+    #         name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
+    #         value: "String",
+    #       }
+    #
+    # @!attribute [rw] operator
+    #   The comparison operator that you want to use as a filter. For
+    #   example, `"Operator": "StringEquals"`.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the value that you want to use as a filter. For example,
+    #   `"Name": "QUICKSIGHT_USER"`.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value of the named item, in this case `QUICKSIGHT_USER`, that
+    #   you want to use as a filter. For example, `"Value":
+    #   "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSearchFilter AWS API Documentation
+    #
+    class DashboardSearchFilter < Struct.new(
+      :operator,
+      :name,
+      :value)
+      include Aws::Structure
+    end
+
     # Dashboard source entity.
     #
     # @note When making an API call, you may pass DashboardSourceEntity
@@ -6204,6 +6240,81 @@ module Aws::QuickSight
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass SearchDashboardsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         aws_account_id: "AwsAccountId", # required
+    #         filters: [ # required
+    #           {
+    #             operator: "StringEquals", # required, accepts StringEquals
+    #             name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
+    #             value: "String",
+    #           },
+    #         ],
+    #         next_token: "String",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] aws_account_id
+    #   The ID of the AWS account that contains the user whose dashboards
+    #   you're searching for.
+    #   @return [String]
+    #
+    # @!attribute [rw] filters
+    #   The filters to apply to the search. Currently, you can search only
+    #   by user name. For example, `"Filters": [ \{ "Name":
+    #   "QUICKSIGHT_USER", "Operator": "StringEquals", "Value":
+    #   "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
+    #   @return [Array<Types::DashboardSearchFilter>]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results, or null if there are no more
+    #   results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to be returned per request.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboardsRequest AWS API Documentation
+    #
+    class SearchDashboardsRequest < Struct.new(
+      :aws_account_id,
+      :filters,
+      :next_token,
+      :max_results)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dashboard_summary_list
+    #   The list of dashboards owned by the user specified in `Filters` in
+    #   your request.
+    #   @return [Array<Types::DashboardSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results, or null if there are no more
+    #   results.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The HTTP status of the request.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] request_id
+    #   The AWS request ID for this operation.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboardsResponse AWS API Documentation
+    #
+    class SearchDashboardsResponse < Struct.new(
+      :dashboard_summary_list,
+      :next_token,
+      :status,
+      :request_id)
+      include Aws::Structure
+    end
+
     # ServiceNow parameters.
     #
     # @note When making an API call, you may pass ServiceNowParameters

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-quicksight
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core