capo-redshift-data 0.3.0__tar.gz → 0.4.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {capo_redshift_data-0.3.0/src/capo_redshift_data.egg-info → capo_redshift_data-0.4.0}/PKG-INFO +1 -1
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/pyproject.toml +1 -1
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_services/async_redshift_data.py +15 -15
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_services/redshift_data.py +15 -15
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_schemas_request.py +1 -1
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_tables_request.py +2 -2
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sql_parameter.py +1 -1
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0/src/capo_redshift_data.egg-info}/PKG-INFO +1 -1
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/LICENSE +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/README.md +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/setup.cfg +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/__init__.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_async.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_identity.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_providers.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_signers.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_sigv4.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_zapros_handler.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_body.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_iter.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/batch_execute_statement.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/cancel_statement.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/describe_statement.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/describe_table.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/execute_statement.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/get_statement_result.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/get_statement_result_v2.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/list_databases.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/list_schemas.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/list_sessions.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/list_statements.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_operations/redshift_data/list_tables.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_pagination.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/__init__.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/errors.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/eventstream.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/serialize.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/xml.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_rule_engine/__init__.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_rule_engine/_aws_partition.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_rule_engine/_endpoint_rule_set.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_rule_engine/_endpoint_runtime.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_services/_aws_config.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_services/_pipeline.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/__init__.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/_base.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/active_sessions_exceeded_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/active_statements_exceeded_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/active_waiting_requests_exceeded_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/batch_execute_statement_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/database_connection_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/execute_statement_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/internal_server_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/query_timeout_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/resource_not_found_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/validation_exception.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/py.typed +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/_prelude/blob.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/_prelude/timestamp.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/batch_execute_statement_input.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/batch_execute_statement_output.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/blob.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/bool.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/boxed_boolean.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/boxed_double.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/boxed_long.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/cancel_statement_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/cancel_statement_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/client_token.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/cluster_identifier_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/column_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/column_metadata.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/column_metadata_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/database_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/db_group_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/describe_statement_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/describe_statement_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/describe_table_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/describe_table_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/execute_statement_input.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/execute_statement_output.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/execution_mode.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/field.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/field_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/formatted_sql_records.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/get_statement_result_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/get_statement_result_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/get_statement_result_v2_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/get_statement_result_v2_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/integer.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_databases_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_databases_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_schemas_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_sessions_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_sessions_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_statements_limit.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_statements_request.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_statements_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/list_tables_response.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/long.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/page_size.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/parameter_name.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/parameter_value.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/query_records.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/result_format_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/schema_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/secret_arn.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/session_alive_seconds.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/session_data.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/session_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/session_status_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sql_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sql_parameters_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sql_records.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_data.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_name_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_status_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_string_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/status_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sub_statement_data.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sub_statement_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/table_list.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/table_member.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/uuid.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/wait_time_seconds.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/workgroup_name_string.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data.egg-info/SOURCES.txt +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data.egg-info/dependency_links.txt +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data.egg-info/requires.txt +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data.egg-info/top_level.txt +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/tests/test_body.py +0 -0
- {capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/tests/test_sigv4.py +0 -0
|
@@ -211,7 +211,7 @@ class AsyncRedshiftDataClient:
|
|
|
211
211
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
212
212
|
] = None,
|
|
213
213
|
) -> "capo_redshift_data.types.batch_execute_statement_output.BatchExecuteStatementOutput":
|
|
214
|
-
|
|
214
|
+
"""<p>Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
215
215
|
|
|
216
216
|
Args:
|
|
217
217
|
sqls: <p>One or more SQL statements to run. The SQL statements run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. By default, the SQL statements are run as a single transaction. If any SQL statement fails, all work is rolled back. To change this behavior, see the <code>ExecutionMode</code> parameter.</p>
|
|
@@ -303,7 +303,7 @@ class AsyncRedshiftDataClient:
|
|
|
303
303
|
*,
|
|
304
304
|
config_overrides: Optional[AsyncRedshiftDataClientConfig] = None,
|
|
305
305
|
) -> "capo_redshift_data.types.cancel_statement_response.CancelStatementResponse":
|
|
306
|
-
|
|
306
|
+
"""<p>Cancels a running query. To be canceled, a query must be running. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
307
307
|
|
|
308
308
|
Args:
|
|
309
309
|
id: <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
@@ -356,7 +356,7 @@ class AsyncRedshiftDataClient:
|
|
|
356
356
|
) -> (
|
|
357
357
|
"capo_redshift_data.types.describe_statement_response.DescribeStatementResponse"
|
|
358
358
|
):
|
|
359
|
-
|
|
359
|
+
"""<p>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. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
360
360
|
|
|
361
361
|
Args:
|
|
362
362
|
id: <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
|
|
@@ -419,7 +419,7 @@ class AsyncRedshiftDataClient:
|
|
|
419
419
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
420
420
|
] = None,
|
|
421
421
|
) -> "capo_redshift_data.types.describe_table_response.DescribeTableResponse":
|
|
422
|
-
|
|
422
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
423
423
|
|
|
424
424
|
Args:
|
|
425
425
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -564,7 +564,7 @@ class AsyncRedshiftDataClient:
|
|
|
564
564
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
565
565
|
] = None,
|
|
566
566
|
) -> "capo_redshift_data.types.execute_statement_output.ExecuteStatementOutput":
|
|
567
|
-
|
|
567
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
568
568
|
|
|
569
569
|
Args:
|
|
570
570
|
sql: <p>The SQL statement text to run. </p>
|
|
@@ -657,7 +657,7 @@ class AsyncRedshiftDataClient:
|
|
|
657
657
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
658
658
|
] = None,
|
|
659
659
|
) -> "capo_redshift_data.types.get_statement_result_response.GetStatementResultResponse":
|
|
660
|
-
|
|
660
|
+
"""<p>Fetches the temporarily cached result of an SQL statement in JSON format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>JSON</code> , or let the format default to JSON. A token is returned to page through the statement results.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
661
661
|
|
|
662
662
|
Args:
|
|
663
663
|
id: <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
@@ -739,7 +739,7 @@ class AsyncRedshiftDataClient:
|
|
|
739
739
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
740
740
|
] = None,
|
|
741
741
|
) -> "capo_redshift_data.types.get_statement_result_v2_response.GetStatementResultV2Response":
|
|
742
|
-
|
|
742
|
+
"""<p>Fetches the temporarily cached result of an SQL statement in CSV format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>CSV</code>. A token is returned to page through the statement results.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
743
743
|
|
|
744
744
|
Args:
|
|
745
745
|
id: <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
@@ -827,7 +827,7 @@ class AsyncRedshiftDataClient:
|
|
|
827
827
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
828
828
|
] = None,
|
|
829
829
|
) -> "capo_redshift_data.types.list_databases_response.ListDatabasesResponse":
|
|
830
|
-
|
|
830
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
831
831
|
|
|
832
832
|
Args:
|
|
833
833
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -940,7 +940,7 @@ class AsyncRedshiftDataClient:
|
|
|
940
940
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
941
941
|
] = None,
|
|
942
942
|
) -> "capo_redshift_data.types.list_schemas_response.ListSchemasResponse":
|
|
943
|
-
|
|
943
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
944
944
|
|
|
945
945
|
Args:
|
|
946
946
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -948,7 +948,7 @@ class AsyncRedshiftDataClient:
|
|
|
948
948
|
db_user: <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
949
949
|
database: <p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
950
950
|
connected_database: <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
951
|
-
schema_pattern: <p>A pattern to filter results by schema name. Within a schema pattern,
|
|
951
|
+
schema_pattern: <p>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. </p>
|
|
952
952
|
next_token: <p>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. </p>
|
|
953
953
|
max_results: <p>The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
954
954
|
workgroup_name: <p>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.</p>
|
|
@@ -1066,7 +1066,7 @@ class AsyncRedshiftDataClient:
|
|
|
1066
1066
|
] = None,
|
|
1067
1067
|
database: Optional["capo_redshift_data.types.string.String"] = None,
|
|
1068
1068
|
) -> "capo_redshift_data.types.list_sessions_response.ListSessionsResponse":
|
|
1069
|
-
|
|
1069
|
+
"""<p>Lists the sessions that the caller created in the last 24 hours. By default, only sessions with a status of <code>AVAILABLE</code> or <code>BUSY</code> are returned. You can filter the results by session status, compute target (cluster or serverless workgroup), or database. To retrieve the metadata for a single session, provide the <code>SessionId</code> parameter. Use <code>NextToken</code> to page through the session list.</p> <p>Returns only the sessions that the caller created. When identity-enhanced role sessions are used, you must provide either the <code>ClusterIdentifier</code> or <code>WorkgroupName</code> parameter to ensure that the IAM Identity Center user can only access the Amazon Redshift IAM Identity Center applications they are assigned. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html"> Trusted identity propagation overview</a>.</p>
|
|
1070
1070
|
|
|
1071
1071
|
Args:
|
|
1072
1072
|
next_token: <p>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.</p>
|
|
@@ -1189,7 +1189,7 @@ class AsyncRedshiftDataClient:
|
|
|
1189
1189
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
1190
1190
|
] = None,
|
|
1191
1191
|
) -> "capo_redshift_data.types.list_statements_response.ListStatementsResponse":
|
|
1192
|
-
|
|
1192
|
+
"""<p>List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. </p> <p>When you use identity-enhanced role sessions to list statements, you must provide either the <code>cluster-identifier</code> or <code>workgroup-name</code> parameter. This ensures that the IdC user can only access the Amazon Redshift IdC applications they are assigned. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html"> Trusted identity propagation overview</a>.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
1193
1193
|
|
|
1194
1194
|
Args:
|
|
1195
1195
|
next_token: <p>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. </p>
|
|
@@ -1310,7 +1310,7 @@ class AsyncRedshiftDataClient:
|
|
|
1310
1310
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
1311
1311
|
] = None,
|
|
1312
1312
|
) -> "capo_redshift_data.types.list_tables_response.ListTablesResponse":
|
|
1313
|
-
|
|
1313
|
+
"""<p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> 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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
1314
1314
|
|
|
1315
1315
|
Args:
|
|
1316
1316
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -1318,8 +1318,8 @@ class AsyncRedshiftDataClient:
|
|
|
1318
1318
|
db_user: <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
1319
1319
|
database: <p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
1320
1320
|
connected_database: <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
1321
|
-
schema_pattern: <p>A pattern to filter results by schema name. Within a schema pattern,
|
|
1322
|
-
table_pattern: <p>A pattern to filter results by table name. Within a table pattern,
|
|
1321
|
+
schema_pattern: <p>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. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1322
|
+
table_pattern: <p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1323
1323
|
next_token: <p>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. </p>
|
|
1324
1324
|
max_results: <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1325
1325
|
workgroup_name: <p>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.</p>
|
|
@@ -211,7 +211,7 @@ class RedshiftDataClient:
|
|
|
211
211
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
212
212
|
] = None,
|
|
213
213
|
) -> "capo_redshift_data.types.batch_execute_statement_output.BatchExecuteStatementOutput":
|
|
214
|
-
|
|
214
|
+
"""<p>Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
215
215
|
|
|
216
216
|
Args:
|
|
217
217
|
sqls: <p>One or more SQL statements to run. The SQL statements run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. By default, the SQL statements are run as a single transaction. If any SQL statement fails, all work is rolled back. To change this behavior, see the <code>ExecutionMode</code> parameter.</p>
|
|
@@ -302,7 +302,7 @@ class RedshiftDataClient:
|
|
|
302
302
|
*,
|
|
303
303
|
config_overrides: Optional[RedshiftDataClientConfig] = None,
|
|
304
304
|
) -> "capo_redshift_data.types.cancel_statement_response.CancelStatementResponse":
|
|
305
|
-
|
|
305
|
+
"""<p>Cancels a running query. To be canceled, a query must be running. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
306
306
|
|
|
307
307
|
Args:
|
|
308
308
|
id: <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
@@ -354,7 +354,7 @@ class RedshiftDataClient:
|
|
|
354
354
|
) -> (
|
|
355
355
|
"capo_redshift_data.types.describe_statement_response.DescribeStatementResponse"
|
|
356
356
|
):
|
|
357
|
-
|
|
357
|
+
"""<p>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. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
358
358
|
|
|
359
359
|
Args:
|
|
360
360
|
id: <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
|
|
@@ -416,7 +416,7 @@ class RedshiftDataClient:
|
|
|
416
416
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
417
417
|
] = None,
|
|
418
418
|
) -> "capo_redshift_data.types.describe_table_response.DescribeTableResponse":
|
|
419
|
-
|
|
419
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
420
420
|
|
|
421
421
|
Args:
|
|
422
422
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -560,7 +560,7 @@ class RedshiftDataClient:
|
|
|
560
560
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
561
561
|
] = None,
|
|
562
562
|
) -> "capo_redshift_data.types.execute_statement_output.ExecuteStatementOutput":
|
|
563
|
-
|
|
563
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
564
564
|
|
|
565
565
|
Args:
|
|
566
566
|
sql: <p>The SQL statement text to run. </p>
|
|
@@ -652,7 +652,7 @@ class RedshiftDataClient:
|
|
|
652
652
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
653
653
|
] = None,
|
|
654
654
|
) -> "capo_redshift_data.types.get_statement_result_response.GetStatementResultResponse":
|
|
655
|
-
|
|
655
|
+
"""<p>Fetches the temporarily cached result of an SQL statement in JSON format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>JSON</code> , or let the format default to JSON. A token is returned to page through the statement results.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
656
656
|
|
|
657
657
|
Args:
|
|
658
658
|
id: <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
@@ -733,7 +733,7 @@ class RedshiftDataClient:
|
|
|
733
733
|
"capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
|
|
734
734
|
] = None,
|
|
735
735
|
) -> "capo_redshift_data.types.get_statement_result_v2_response.GetStatementResultV2Response":
|
|
736
|
-
|
|
736
|
+
"""<p>Fetches the temporarily cached result of an SQL statement in CSV format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>CSV</code>. A token is returned to page through the statement results.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
737
737
|
|
|
738
738
|
Args:
|
|
739
739
|
id: <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
@@ -820,7 +820,7 @@ class RedshiftDataClient:
|
|
|
820
820
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
821
821
|
] = None,
|
|
822
822
|
) -> "capo_redshift_data.types.list_databases_response.ListDatabasesResponse":
|
|
823
|
-
|
|
823
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
824
824
|
|
|
825
825
|
Args:
|
|
826
826
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -932,7 +932,7 @@ class RedshiftDataClient:
|
|
|
932
932
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
933
933
|
] = None,
|
|
934
934
|
) -> "capo_redshift_data.types.list_schemas_response.ListSchemasResponse":
|
|
935
|
-
|
|
935
|
+
"""<p>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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
936
936
|
|
|
937
937
|
Args:
|
|
938
938
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -940,7 +940,7 @@ class RedshiftDataClient:
|
|
|
940
940
|
db_user: <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
941
941
|
database: <p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
942
942
|
connected_database: <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
943
|
-
schema_pattern: <p>A pattern to filter results by schema name. Within a schema pattern,
|
|
943
|
+
schema_pattern: <p>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. </p>
|
|
944
944
|
next_token: <p>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. </p>
|
|
945
945
|
max_results: <p>The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
946
946
|
workgroup_name: <p>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.</p>
|
|
@@ -1057,7 +1057,7 @@ class RedshiftDataClient:
|
|
|
1057
1057
|
] = None,
|
|
1058
1058
|
database: Optional["capo_redshift_data.types.string.String"] = None,
|
|
1059
1059
|
) -> "capo_redshift_data.types.list_sessions_response.ListSessionsResponse":
|
|
1060
|
-
|
|
1060
|
+
"""<p>Lists the sessions that the caller created in the last 24 hours. By default, only sessions with a status of <code>AVAILABLE</code> or <code>BUSY</code> are returned. You can filter the results by session status, compute target (cluster or serverless workgroup), or database. To retrieve the metadata for a single session, provide the <code>SessionId</code> parameter. Use <code>NextToken</code> to page through the session list.</p> <p>Returns only the sessions that the caller created. When identity-enhanced role sessions are used, you must provide either the <code>ClusterIdentifier</code> or <code>WorkgroupName</code> parameter to ensure that the IAM Identity Center user can only access the Amazon Redshift IAM Identity Center applications they are assigned. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html"> Trusted identity propagation overview</a>.</p>
|
|
1061
1061
|
|
|
1062
1062
|
Args:
|
|
1063
1063
|
next_token: <p>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.</p>
|
|
@@ -1179,7 +1179,7 @@ class RedshiftDataClient:
|
|
|
1179
1179
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
1180
1180
|
] = None,
|
|
1181
1181
|
) -> "capo_redshift_data.types.list_statements_response.ListStatementsResponse":
|
|
1182
|
-
|
|
1182
|
+
"""<p>List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. </p> <p>When you use identity-enhanced role sessions to list statements, you must provide either the <code>cluster-identifier</code> or <code>workgroup-name</code> parameter. This ensures that the IdC user can only access the Amazon Redshift IdC applications they are assigned. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html"> Trusted identity propagation overview</a>.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
1183
1183
|
|
|
1184
1184
|
Args:
|
|
1185
1185
|
next_token: <p>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. </p>
|
|
@@ -1299,7 +1299,7 @@ class RedshiftDataClient:
|
|
|
1299
1299
|
"capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
|
|
1300
1300
|
] = None,
|
|
1301
1301
|
) -> "capo_redshift_data.types.list_tables_response.ListTablesResponse":
|
|
1302
|
-
|
|
1302
|
+
"""<p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> 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: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
|
|
1303
1303
|
|
|
1304
1304
|
Args:
|
|
1305
1305
|
cluster_identifier: <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
@@ -1307,8 +1307,8 @@ class RedshiftDataClient:
|
|
|
1307
1307
|
db_user: <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
1308
1308
|
database: <p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
1309
1309
|
connected_database: <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
1310
|
-
schema_pattern: <p>A pattern to filter results by schema name. Within a schema pattern,
|
|
1311
|
-
table_pattern: <p>A pattern to filter results by table name. Within a table pattern,
|
|
1310
|
+
schema_pattern: <p>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. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1311
|
+
table_pattern: <p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1312
1312
|
next_token: <p>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. </p>
|
|
1313
1313
|
max_results: <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1314
1314
|
workgroup_name: <p>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.</p>
|
|
@@ -28,7 +28,7 @@ class ListSchemasRequest(TypedDict, closed=True):
|
|
|
28
28
|
connected_database: NotRequired["capo_redshift_data.types.string.String"]
|
|
29
29
|
"""<p>A database name. The connected database is specified when you connect with your authentication credentials. </p>"""
|
|
30
30
|
schema_pattern: NotRequired["capo_redshift_data.types.string.String"]
|
|
31
|
-
|
|
31
|
+
"""<p>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. </p>"""
|
|
32
32
|
next_token: NotRequired["capo_redshift_data.types.string.String"]
|
|
33
33
|
"""<p>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. </p>"""
|
|
34
34
|
max_results: "capo_redshift_data.types.page_size.PageSize"
|
|
@@ -28,9 +28,9 @@ class ListTablesRequest(TypedDict, closed=True):
|
|
|
28
28
|
connected_database: NotRequired["capo_redshift_data.types.string.String"]
|
|
29
29
|
"""<p>A database name. The connected database is specified when you connect with your authentication credentials. </p>"""
|
|
30
30
|
schema_pattern: NotRequired["capo_redshift_data.types.string.String"]
|
|
31
|
-
|
|
31
|
+
"""<p>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. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>"""
|
|
32
32
|
table_pattern: NotRequired["capo_redshift_data.types.string.String"]
|
|
33
|
-
|
|
33
|
+
"""<p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>"""
|
|
34
34
|
next_token: NotRequired["capo_redshift_data.types.string.String"]
|
|
35
35
|
"""<p>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. </p>"""
|
|
36
36
|
max_results: "capo_redshift_data.types.page_size.PageSize"
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sql_parameter.py
RENAMED
|
@@ -15,7 +15,7 @@ class SqlParameter(TypedDict, closed=True):
|
|
|
15
15
|
name: "capo_redshift_data.types.parameter_name.ParameterName"
|
|
16
16
|
"""<p>The name of the parameter.</p>"""
|
|
17
17
|
value: "capo_redshift_data.types.parameter_value.ParameterValue"
|
|
18
|
-
|
|
18
|
+
"""<p>The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the <i>Amazon Redshift Database Developer Guide</i>. </p>"""
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
# --- awsJson1_1 ser/de ---
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_identity.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_providers.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_signers.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_auth/_sigv4.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/__init__.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/errors.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/serialize.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_protocol/xml.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/_services/_pipeline.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/__init__.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/errors/_base.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/_prelude/blob.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/boxed_boolean.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/boxed_double.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/boxed_long.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/client_token.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/column_list.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/database_list.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/db_group_list.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/execution_mode.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/field_list.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/integer.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/page_size.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/parameter_name.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/query_records.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/schema_list.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/secret_arn.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/session_data.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/session_list.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sql_list.py
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/sql_records.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_data.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/statement_list.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/status_string.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/string.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/table_list.py
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data/types/table_member.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data.egg-info/SOURCES.txt
RENAMED
|
File without changes
|
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data.egg-info/requires.txt
RENAMED
|
File without changes
|
{capo_redshift_data-0.3.0 → capo_redshift_data-0.4.0}/src/capo_redshift_data.egg-info/top_level.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|