|
Unix VPS
Support
FAQ
Network
Miscellaneous
|
| Paws::RedshiftData(3) | User Contributed Perl Documentation | Paws::RedshiftData(3) |
NAME
Paws::RedshiftData - Perl Interface to AWS Redshift Data API Service
SYNOPSIS
use Paws;
my $obj = Paws->service('RedshiftData');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);
DESCRIPTION
You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run individual SQL statements, which are committed if the statement succeeds.
For more information about the Amazon Redshift Data API, see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon Redshift Cluster Management Guide.
For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20>
METHODS
CancelStatement
Each argument is described in detail in: Paws::RedshiftData::CancelStatement
Returns: a Paws::RedshiftData::CancelStatementResponse instance
Cancels a running query. To be canceled, a query must be running.
DescribeStatement
Each argument is described in detail in: Paws::RedshiftData::DescribeStatement
Returns: a Paws::RedshiftData::DescribeStatementResponse instance
Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.
DescribeTable
- ClusterIdentifier => Str
- Database => Str
- [ConnectedDatabase => Str]
- [DbUser => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [Schema => Str]
- [SecretArn => Str]
- [Table => Str]
Each argument is described in detail in: Paws::RedshiftData::DescribeTable
Returns: a Paws::RedshiftData::DescribeTableResponse instance
Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:
- AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
- Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the "redshift:GetClusterCredentials" operation is required to use this method.
ExecuteStatement
- ClusterIdentifier => Str
- Sql => Str
- [Database => Str]
- [DbUser => Str]
- [Parameters => ArrayRef[Paws::RedshiftData::SqlParameter]]
- [SecretArn => Str]
- [StatementName => Str]
- [WithEvent => Bool]
Each argument is described in detail in: Paws::RedshiftData::ExecuteStatement
Returns: a Paws::RedshiftData::ExecuteStatementOutput instance
Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:
- AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
- Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the "redshift:GetClusterCredentials" operation is required to use this method.
GetStatementResult
- Id => Str
- [NextToken => Str]
Each argument is described in detail in: Paws::RedshiftData::GetStatementResult
Returns: a Paws::RedshiftData::GetStatementResultResponse instance
Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.
ListDatabases
- ClusterIdentifier => Str
- [Database => Str]
- [DbUser => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [SecretArn => Str]
Each argument is described in detail in: Paws::RedshiftData::ListDatabases
Returns: a Paws::RedshiftData::ListDatabasesResponse instance
List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:
- AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
- Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the "redshift:GetClusterCredentials" operation is required to use this method.
ListSchemas
- ClusterIdentifier => Str
- Database => Str
- [ConnectedDatabase => Str]
- [DbUser => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [SchemaPattern => Str]
- [SecretArn => Str]
Each argument is described in detail in: Paws::RedshiftData::ListSchemas
Returns: a Paws::RedshiftData::ListSchemasResponse instance
Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:
- AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
- Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the "redshift:GetClusterCredentials" operation is required to use this method.
ListStatements
- [MaxResults => Int]
- [NextToken => Str]
- [RoleLevel => Bool]
- [StatementName => Str]
- [Status => Str]
Each argument is described in detail in: Paws::RedshiftData::ListStatements
Returns: a Paws::RedshiftData::ListStatementsResponse instance
List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
ListTables
- ClusterIdentifier => Str
- Database => Str
- [ConnectedDatabase => Str]
- [DbUser => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [SchemaPattern => Str]
- [SecretArn => Str]
- [TablePattern => Str]
Each argument is described in detail in: Paws::RedshiftData::ListTables
Returns: a Paws::RedshiftData::ListTablesResponse instance
List the tables in a database. If neither "SchemaPattern" nor "TablePattern" are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:
- AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
- Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the "redshift:GetClusterCredentials" operation is required to use this method.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
DescribeAllTable(sub { },ClusterIdentifier => Str, Database => Str, [ConnectedDatabase => Str, DbUser => Str, MaxResults => Int, NextToken => Str, Schema => Str, SecretArn => Str, Table => Str])
DescribeAllTable(ClusterIdentifier => Str, Database => Str, [ConnectedDatabase => Str, DbUser => Str, MaxResults => Int, NextToken => Str, Schema => Str, SecretArn => Str, Table => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ColumnList, passing the object as the first parameter, and the string 'ColumnList' as the second parameter
If not, it will return a a Paws::RedshiftData::DescribeTableResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
GetAllStatementResult(sub { },Id => Str, [NextToken => Str])
GetAllStatementResult(Id => Str, [NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Records, passing the object as the first parameter, and the string 'Records' as the second parameter
If not, it will return a a Paws::RedshiftData::GetStatementResultResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllDatabases(sub { },ClusterIdentifier => Str, [Database => Str, DbUser => Str, MaxResults => Int, NextToken => Str, SecretArn => Str])
ListAllDatabases(ClusterIdentifier => Str, [Database => Str, DbUser => Str, MaxResults => Int, NextToken => Str, SecretArn => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Databases, passing the object as the first parameter, and the string 'Databases' as the second parameter
If not, it will return a a Paws::RedshiftData::ListDatabasesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllSchemas(sub { },ClusterIdentifier => Str, Database => Str, [ConnectedDatabase => Str, DbUser => Str, MaxResults => Int, NextToken => Str, SchemaPattern => Str, SecretArn => Str])
ListAllSchemas(ClusterIdentifier => Str, Database => Str, [ConnectedDatabase => Str, DbUser => Str, MaxResults => Int, NextToken => Str, SchemaPattern => Str, SecretArn => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Schemas, passing the object as the first parameter, and the string 'Schemas' as the second parameter
If not, it will return a a Paws::RedshiftData::ListSchemasResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllStatements(sub { },[MaxResults => Int, NextToken => Str, RoleLevel => Bool, StatementName => Str, Status => Str])
ListAllStatements([MaxResults => Int, NextToken => Str, RoleLevel => Bool, StatementName => Str, Status => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Statements, passing the object as the first parameter, and the string 'Statements' as the second parameter
If not, it will return a a Paws::RedshiftData::ListStatementsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllTables(sub { },ClusterIdentifier => Str, Database => Str, [ConnectedDatabase => Str, DbUser => Str, MaxResults => Int, NextToken => Str, SchemaPattern => Str, SecretArn => Str, TablePattern => Str])
ListAllTables(ClusterIdentifier => Str, Database => Str, [ConnectedDatabase => Str, DbUser => Str, MaxResults => Int, NextToken => Str, SchemaPattern => Str, SecretArn => Str, TablePattern => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Tables, passing the object as the first parameter, and the string 'Tables' as the second parameter
If not, it will return a a Paws::RedshiftData::ListTablesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
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>
| 2022-06-01 | perl v5.40.2 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.