Class: Aws::RedshiftDataAPIService::Types::ListSchemasRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifier ⇒ String

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#connected_database ⇒ String

A database name. The connected database is specified when you connect with your authentication credentials.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#database ⇒ String

The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#db_user ⇒ String

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.

Returns:

  • (Integer) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#schema_pattern ⇒ String

A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ String

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 946

class ListSchemasRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end