NAME

Paws::RedshiftData::ListSchemas - Arguments for method ListSchemas on Paws::RedshiftData

DESCRIPTION

This class represents the parameters used for calling the method ListSchemas on the Redshift Data API Service service. Use the attributes of this class as arguments to method ListSchemas.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListSchemas.

SYNOPSIS

my $redshift-data = Paws->service('RedshiftData');
my $ListSchemasResponse = $redshift -data->ListSchemas(
  ClusterIdentifier => 'MyLocation',
  Database          => 'MyString',
  ConnectedDatabase => 'MyString',       # OPTIONAL
  DbUser            => 'MyString',       # OPTIONAL
  MaxResults        => 1,                # OPTIONAL
  NextToken         => 'MyString',       # OPTIONAL
  SchemaPattern     => 'MyString',       # OPTIONAL
  SecretArn         => 'MySecretArn',    # OPTIONAL
);

# Results:
my $NextToken = $ListSchemasResponse->NextToken;
my $Schemas   = $ListSchemasResponse->Schemas;

# Returns a L<Paws::RedshiftData::ListSchemasResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/redshift-data/ListSchemas

ATTRIBUTES

REQUIRED ClusterIdentifier => Str

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

ConnectedDatabase => Str

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

REQUIRED Database => Str

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.

DbUser => Str

The database user name. This parameter is required when authenticating using temporary credentials.

MaxResults => Int

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.

NextToken => Str

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.

SchemaPattern => Str

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.

SecretArn => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method ListSchemas in Paws::RedshiftData

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues