« blib/lib/Paws/RedshiftData/DescribeStatementResponse.pm
↑ Summary
blib/lib/Paws/RedshiftData/DescribeTableResponse.pm »
| 1 | |||
| 2 | package Paws::RedshiftData::DescribeTable; | ||
| 3 | use Moose; | ||
| 4 | has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ConnectedDatabase => (is => 'ro', isa => 'Str'); | ||
| 6 | has Database => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has DbUser => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 9 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 10 | has Schema => (is => 'ro', isa => 'Str'); | ||
| 11 | has SecretArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has Table => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeTable'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedshiftData::DescribeTableResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::RedshiftData::DescribeTable - Arguments for method DescribeTable on L<Paws::RedshiftData> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeTable on the | ||
| 30 | L<Redshift Data API Service|Paws::RedshiftData> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeTable. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeTable. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $redshift-data = Paws->service('RedshiftData'); | ||
| 38 | my $DescribeTableResponse = $redshift -data->DescribeTable( | ||
| 39 | ClusterIdentifier => 'MyLocation', | ||
| 40 | Database => 'MyString', | ||
| 41 | ConnectedDatabase => 'MyString', # OPTIONAL | ||
| 42 | DbUser => 'MyString', # OPTIONAL | ||
| 43 | MaxResults => 1, # OPTIONAL | ||
| 44 | NextToken => 'MyString', # OPTIONAL | ||
| 45 | Schema => 'MyString', # OPTIONAL | ||
| 46 | SecretArn => 'MySecretArn', # OPTIONAL | ||
| 47 | Table => 'MyString', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $ColumnList = $DescribeTableResponse->ColumnList; | ||
| 52 | my $NextToken = $DescribeTableResponse->NextToken; | ||
| 53 | my $TableName = $DescribeTableResponse->TableName; | ||
| 54 | |||
| 55 | # Returns a L<Paws::RedshiftData::DescribeTableResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift-data/DescribeTable> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 64 | |||
| 65 | The cluster identifier. This parameter is required when authenticating | ||
| 66 | using either AWS Secrets Manager or temporary credentials. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 ConnectedDatabase => Str | ||
| 71 | |||
| 72 | A database name. The connected database is specified when you connect | ||
| 73 | with your authentication credentials. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Database => Str | ||
| 78 | |||
| 79 | The name of the database that contains the tables to be described. If | ||
| 80 | C<ConnectedDatabase> is not specified, this is also the database to | ||
| 81 | connect to with your authentication credentials. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 DbUser => Str | ||
| 86 | |||
| 87 | The database user name. This parameter is required when authenticating | ||
| 88 | using temporary credentials. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 MaxResults => Int | ||
| 93 | |||
| 94 | The maximum number of tables to return in the response. If more tables | ||
| 95 | exist than fit in one response, then C<NextToken> is returned to page | ||
| 96 | through the results. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 NextToken => Str | ||
| 101 | |||
| 102 | A value that indicates the starting point for the next set of response | ||
| 103 | records in a subsequent request. If a value is returned in a response, | ||
| 104 | you can retrieve the next set of records by providing this returned | ||
| 105 | NextToken value in the next NextToken parameter and retrying the | ||
| 106 | command. If the NextToken field is empty, all response records have | ||
| 107 | been retrieved for the request. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 Schema => Str | ||
| 112 | |||
| 113 | The schema that contains the table. If no schema is specified, then | ||
| 114 | matching tables for all schemas are returned. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 SecretArn => Str | ||
| 119 | |||
| 120 | The name or ARN of the secret that enables access to the database. This | ||
| 121 | parameter is required when authenticating using AWS Secrets Manager. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 Table => Str | ||
| 126 | |||
| 127 | The table name. If no table is specified, then all tables for all | ||
| 128 | matching schemas are returned. If no table and no schema is specified, | ||
| 129 | then all tables for all schemas in the database are returned | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method DescribeTable in L<Paws::RedshiftData> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |