client.rb in aws-sdk-redshiftserverless-1.17.0

- old
+ new

@@ -474,10 +474,52 @@
     def convert_recovery_point_to_snapshot(params = {}, options = {})
       req = build_request(:convert_recovery_point_to_snapshot, params)
       req.send_request(options)
     end
 
+    # Creates a custom domain association for Amazon Redshift Serverless.
+    #
+    # @option params [required, String] :custom_domain_certificate_arn
+    #   The custom domain name’s certificate Amazon resource name (ARN).
+    #
+    # @option params [required, String] :custom_domain_name
+    #   The custom domain name to associate with the workgroup.
+    #
+    # @option params [required, String] :workgroup_name
+    #   The name of the workgroup associated with the database.
+    #
+    # @return [Types::CreateCustomDomainAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateCustomDomainAssociationResponse#custom_domain_certificate_arn #custom_domain_certificate_arn} => String
+    #   * {Types::CreateCustomDomainAssociationResponse#custom_domain_certificate_expiry_time #custom_domain_certificate_expiry_time} => Time
+    #   * {Types::CreateCustomDomainAssociationResponse#custom_domain_name #custom_domain_name} => String
+    #   * {Types::CreateCustomDomainAssociationResponse#workgroup_name #workgroup_name} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_custom_domain_association({
+    #     custom_domain_certificate_arn: "CustomDomainCertificateArnString", # required
+    #     custom_domain_name: "CustomDomainName", # required
+    #     workgroup_name: "WorkgroupName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.custom_domain_certificate_arn #=> String
+    #   resp.custom_domain_certificate_expiry_time #=> Time
+    #   resp.custom_domain_name #=> String
+    #   resp.workgroup_name #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateCustomDomainAssociation AWS API Documentation
+    #
+    # @overload create_custom_domain_association(params = {})
+    # @param [Hash] params ({})
+    def create_custom_domain_association(params = {}, options = {})
+      req = build_request(:create_custom_domain_association, params)
+      req.send_request(options)
+    end
+
     # Creates an Amazon Redshift Serverless managed VPC endpoint.
     #
     # @option params [required, String] :endpoint_name
     #   The name of the VPC endpoint. An endpoint name must contain 1-30
     #   characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The
@@ -858,10 +900,13 @@
     #   resp.workgroup.base_capacity #=> Integer
     #   resp.workgroup.config_parameters #=> Array
     #   resp.workgroup.config_parameters[0].parameter_key #=> String
     #   resp.workgroup.config_parameters[0].parameter_value #=> String
     #   resp.workgroup.creation_date #=> Time
+    #   resp.workgroup.custom_domain_certificate_arn #=> String
+    #   resp.workgroup.custom_domain_certificate_expiry_time #=> Time
+    #   resp.workgroup.custom_domain_name #=> String
     #   resp.workgroup.endpoint.address #=> String
     #   resp.workgroup.endpoint.port #=> Integer
     #   resp.workgroup.endpoint.vpc_endpoints #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
@@ -892,10 +937,36 @@
     def create_workgroup(params = {}, options = {})
       req = build_request(:create_workgroup, params)
       req.send_request(options)
     end
 
+    # Deletes a custom domain association for Amazon Redshift Serverless.
+    #
+    # @option params [required, String] :custom_domain_name
+    #   The custom domain name associated with the workgroup.
+    #
+    # @option params [required, String] :workgroup_name
+    #   The name of the workgroup associated with the database.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_custom_domain_association({
+    #     custom_domain_name: "CustomDomainName", # required
+    #     workgroup_name: "WorkgroupName", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation AWS API Documentation
+    #
+    # @overload delete_custom_domain_association(params = {})
+    # @param [Hash] params ({})
+    def delete_custom_domain_association(params = {}, options = {})
+      req = build_request(:delete_custom_domain_association, params)
+      req.send_request(options)
+    end
+
     # Deletes an Amazon Redshift Serverless managed VPC endpoint.
     #
     # @option params [required, String] :endpoint_name
     #   The name of the VPC endpoint to delete.
     #
@@ -1120,10 +1191,13 @@
     #   resp.workgroup.base_capacity #=> Integer
     #   resp.workgroup.config_parameters #=> Array
     #   resp.workgroup.config_parameters[0].parameter_key #=> String
     #   resp.workgroup.config_parameters[0].parameter_value #=> String
     #   resp.workgroup.creation_date #=> Time
+    #   resp.workgroup.custom_domain_certificate_arn #=> String
+    #   resp.workgroup.custom_domain_certificate_expiry_time #=> Time
+    #   resp.workgroup.custom_domain_name #=> String
     #   resp.workgroup.endpoint.address #=> String
     #   resp.workgroup.endpoint.port #=> Integer
     #   resp.workgroup.endpoint.vpc_endpoints #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
@@ -1163,10 +1237,14 @@
     # optionally specify a duration between 900 seconds (15 minutes) and
     # 3600 seconds (60 minutes).
     #
     #      <p>The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p>
     #
+    # @option params [String] :custom_domain_name
+    #   The custom domain name associated with the workgroup. The custom
+    #   domain name or the workgroup name must be included in the request.
+    #
     # @option params [String] :db_name
     #   The name of the database to get temporary authorization to log on to.
     #
     #   Constraints:
     #
@@ -1188,11 +1266,11 @@
     #
     # @option params [Integer] :duration_seconds
     #   The number of seconds until the returned temporary password expires.
     #   The minimum is 900 seconds, and the maximum is 3600 seconds.
     #
-    # @option params [required, String] :workgroup_name
+    # @option params [String] :workgroup_name
     #   The name of the workgroup associated with the database.
     #
     # @return [Types::GetCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetCredentialsResponse#db_password #db_password} => String
@@ -1201,13 +1279,14 @@
     #   * {Types::GetCredentialsResponse#next_refresh_time #next_refresh_time} => Time
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_credentials({
+    #     custom_domain_name: "CustomDomainName",
     #     db_name: "DbName",
     #     duration_seconds: 1,
-    #     workgroup_name: "WorkgroupName", # required
+    #     workgroup_name: "WorkgroupName",
     #   })
     #
     # @example Response structure
     #
     #   resp.db_password #=> String
@@ -1222,10 +1301,48 @@
     def get_credentials(params = {}, options = {})
       req = build_request(:get_credentials, params)
       req.send_request(options)
     end
 
+    # Gets information about a specific custom domain association.
+    #
+    # @option params [required, String] :custom_domain_name
+    #   The custom domain name associated with the workgroup.
+    #
+    # @option params [required, String] :workgroup_name
+    #   The name of the workgroup associated with the database.
+    #
+    # @return [Types::GetCustomDomainAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetCustomDomainAssociationResponse#custom_domain_certificate_arn #custom_domain_certificate_arn} => String
+    #   * {Types::GetCustomDomainAssociationResponse#custom_domain_certificate_expiry_time #custom_domain_certificate_expiry_time} => Time
+    #   * {Types::GetCustomDomainAssociationResponse#custom_domain_name #custom_domain_name} => String
+    #   * {Types::GetCustomDomainAssociationResponse#workgroup_name #workgroup_name} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_custom_domain_association({
+    #     custom_domain_name: "CustomDomainName", # required
+    #     workgroup_name: "WorkgroupName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.custom_domain_certificate_arn #=> String
+    #   resp.custom_domain_certificate_expiry_time #=> Time
+    #   resp.custom_domain_name #=> String
+    #   resp.workgroup_name #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetCustomDomainAssociation AWS API Documentation
+    #
+    # @overload get_custom_domain_association(params = {})
+    # @param [Hash] params ({})
+    def get_custom_domain_association(params = {}, options = {})
+      req = build_request(:get_custom_domain_association, params)
+      req.send_request(options)
+    end
+
     # Returns information, such as the name, about a VPC endpoint.
     #
     # @option params [required, String] :endpoint_name
     #   The name of the VPC endpoint to return information for.
     #
@@ -1530,10 +1647,13 @@
     #   resp.workgroup.base_capacity #=> Integer
     #   resp.workgroup.config_parameters #=> Array
     #   resp.workgroup.config_parameters[0].parameter_key #=> String
     #   resp.workgroup.config_parameters[0].parameter_value #=> String
     #   resp.workgroup.creation_date #=> Time
+    #   resp.workgroup.custom_domain_certificate_arn #=> String
+    #   resp.workgroup.custom_domain_certificate_expiry_time #=> Time
+    #   resp.workgroup.custom_domain_name #=> String
     #   resp.workgroup.endpoint.address #=> String
     #   resp.workgroup.endpoint.port #=> Integer
     #   resp.workgroup.endpoint.vpc_endpoints #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
@@ -1564,10 +1684,61 @@
     def get_workgroup(params = {}, options = {})
       req = build_request(:get_workgroup, params)
       req.send_request(options)
     end
 
+    # Lists custom domain associations for Amazon Redshift Serverless.
+    #
+    # @option params [String] :custom_domain_certificate_arn
+    #   The custom domain name’s certificate Amazon resource name (ARN).
+    #
+    # @option params [String] :custom_domain_name
+    #   The custom domain name associated with the workgroup.
+    #
+    # @option params [Integer] :max_results
+    #   An optional parameter that specifies the maximum number of results to
+    #   return. You can use `nextToken` to display the next page of results.
+    #
+    # @option params [String] :next_token
+    #   When `nextToken` is returned, there are more results available. The
+    #   value of `nextToken` is a unique pagination token for each page. Make
+    #   the call again using the returned token to retrieve the next page.
+    #
+    # @return [Types::ListCustomDomainAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListCustomDomainAssociationsResponse#associations #associations} => Array&lt;Types::Association&gt;
+    #   * {Types::ListCustomDomainAssociationsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_custom_domain_associations({
+    #     custom_domain_certificate_arn: "CustomDomainCertificateArnString",
+    #     custom_domain_name: "CustomDomainName",
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.associations #=> Array
+    #   resp.associations[0].custom_domain_certificate_arn #=> String
+    #   resp.associations[0].custom_domain_certificate_expiry_time #=> Time
+    #   resp.associations[0].custom_domain_name #=> String
+    #   resp.associations[0].workgroup_name #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListCustomDomainAssociations AWS API Documentation
+    #
+    # @overload list_custom_domain_associations(params = {})
+    # @param [Hash] params ({})
+    def list_custom_domain_associations(params = {}, options = {})
+      req = build_request(:list_custom_domain_associations, params)
+      req.send_request(options)
+    end
+
     # Returns an array of `EndpointAccess` objects and relevant information.
     #
     # @option params [Integer] :max_results
     #   An optional parameter that specifies the maximum number of results to
     #   return. You can use `nextToken` to display the next page of results.
@@ -2018,10 +2189,13 @@
     #   resp.workgroups[0].base_capacity #=> Integer
     #   resp.workgroups[0].config_parameters #=> Array
     #   resp.workgroups[0].config_parameters[0].parameter_key #=> String
     #   resp.workgroups[0].config_parameters[0].parameter_value #=> String
     #   resp.workgroups[0].creation_date #=> Time
+    #   resp.workgroups[0].custom_domain_certificate_arn #=> String
+    #   resp.workgroups[0].custom_domain_certificate_expiry_time #=> Time
+    #   resp.workgroups[0].custom_domain_name #=> String
     #   resp.workgroups[0].endpoint.address #=> String
     #   resp.workgroups[0].endpoint.port #=> Integer
     #   resp.workgroups[0].endpoint.vpc_endpoints #=> Array
     #   resp.workgroups[0].endpoint.vpc_endpoints[0].network_interfaces #=> Array
     #   resp.workgroups[0].endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
@@ -2370,10 +2544,54 @@
     def untag_resource(params = {}, options = {})
       req = build_request(:untag_resource, params)
       req.send_request(options)
     end
 
+    # Updates an Amazon Redshift Serverless certificate associated with a
+    # custom domain.
+    #
+    # @option params [required, String] :custom_domain_certificate_arn
+    #   The custom domain name’s certificate Amazon resource name (ARN). This
+    #   is optional.
+    #
+    # @option params [required, String] :custom_domain_name
+    #   The custom domain name associated with the workgroup.
+    #
+    # @option params [required, String] :workgroup_name
+    #   The name of the workgroup associated with the database.
+    #
+    # @return [Types::UpdateCustomDomainAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateCustomDomainAssociationResponse#custom_domain_certificate_arn #custom_domain_certificate_arn} => String
+    #   * {Types::UpdateCustomDomainAssociationResponse#custom_domain_certificate_expiry_time #custom_domain_certificate_expiry_time} => Time
+    #   * {Types::UpdateCustomDomainAssociationResponse#custom_domain_name #custom_domain_name} => String
+    #   * {Types::UpdateCustomDomainAssociationResponse#workgroup_name #workgroup_name} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_custom_domain_association({
+    #     custom_domain_certificate_arn: "CustomDomainCertificateArnString", # required
+    #     custom_domain_name: "CustomDomainName", # required
+    #     workgroup_name: "WorkgroupName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.custom_domain_certificate_arn #=> String
+    #   resp.custom_domain_certificate_expiry_time #=> Time
+    #   resp.custom_domain_name #=> String
+    #   resp.workgroup_name #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation AWS API Documentation
+    #
+    # @overload update_custom_domain_association(params = {})
+    # @param [Hash] params ({})
+    def update_custom_domain_association(params = {}, options = {})
+      req = build_request(:update_custom_domain_association, params)
+      req.send_request(options)
+    end
+
     # Updates an Amazon Redshift Serverless managed endpoint.
     #
     # @option params [required, String] :endpoint_name
     #   The name of the VPC endpoint to update.
     #
@@ -2693,10 +2911,13 @@
     #   resp.workgroup.base_capacity #=> Integer
     #   resp.workgroup.config_parameters #=> Array
     #   resp.workgroup.config_parameters[0].parameter_key #=> String
     #   resp.workgroup.config_parameters[0].parameter_value #=> String
     #   resp.workgroup.creation_date #=> Time
+    #   resp.workgroup.custom_domain_certificate_arn #=> String
+    #   resp.workgroup.custom_domain_certificate_expiry_time #=> Time
+    #   resp.workgroup.custom_domain_name #=> String
     #   resp.workgroup.endpoint.address #=> String
     #   resp.workgroup.endpoint.port #=> Integer
     #   resp.workgroup.endpoint.vpc_endpoints #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
     #   resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
@@ -2740,10 +2961,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-redshiftserverless'
-      context[:gem_version] = '1.16.0'
+      context[:gem_version] = '1.17.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # @api private
     # @deprecated