Package {paws.analytics}

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] An array of query IDs.

[required] A list of prepared statement names to return.

[required] The name of the workgroup to which the prepared statements belong.

[required] An array of query execution IDs.

[required] The name of the capacity reservation to cancel.

[required] The number of requested data processing units.

[required] The name of the capacity reservation to create.

The tags for the capacity reservation.

[required] The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

For FEDERATED type the catalog name has following considerations and limits:

• The catalog name allows special characters such as ⁠_ , @ , \ , - ⁠. These characters are replaced with a hyphen (-) when creating the CFN Stack Name and with an underscore (_) when creating the Lambda Function and Glue Connection Name.

• The catalog name has a theoretical limit of 128 characters. However, since we use it to create other resources that allow less characters and we prepend a prefix to it, the actual catalog name limit for FEDERATED catalog is 64 - 23 = 41 characters.

[required] The type of data catalog to create: LAMBDA for a federated catalog, GLUE for an Glue Data Catalog, and HIVE for an external Apache Hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.

For FEDERATED type, we do not support IAM identity center.

A description of the data catalog to be created.

Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.

• For the HIVE data catalog type, use the following syntax. The ⁠metadata-function⁠ parameter is required. ⁠The sdk-version⁠ parameter is optional and defaults to the currently supported version.

  ⁠metadata-function=lambda_arn, sdk-version=version_number ⁠

• For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

  • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

    ⁠metadata-function=lambda_arn, record-function=lambda_arn ⁠

  • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

    ⁠function=lambda_arn ⁠

• The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.

  catalog-id=catalog_id

  • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.

• The FEDERATED data catalog type uses one of the following parameters, but not both. Use connection-arn for an existing Glue connection. Use connection-type and connection-properties to specify the configuration setting for a new connection.

  • ⁠connection-arn:<glue_connection_arn_to_reuse> ⁠

  • lambda-role-arn (optional): The execution role to use for the Lambda function. If not provided, one is created.

  • ⁠connection-type:MYSQL|REDSHIFT|...., connection-properties:"<json_string>"⁠

    For \<json_string\> , use escaped JSON text, as in the following example.

    ⁠"{\"spill_bucket\":\"my_spill\",\"spill_prefix\":\"athena-spill\",\"host\":\"abc12345.snowflakecomputing.com\",\"port\":\"1234\",\"warehouse\":\"DEV_WH\",\"database\":\"TEST\",\"schema\":\"PUBLIC\",\"SecretArn\":\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\"}"⁠

A list of comma separated tags to add to the data catalog that is created. All the resources that are created by the create_data_catalog API operation with FEDERATED type will have the tag federated_athena_datacatalog="true". This includes the CFN Stack, Glue Connection, Athena DataCatalog, and all the resources created as part of the CFN Stack (Lambda Function, IAM policies/roles).

[required] The query name.

The query description.

[required] The database to which the query belongs.

[required] The contents of the query with all query statements.

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another create_named_query request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

The name of the workgroup in which the named query is being created.

[required] The name of the Spark enabled workgroup in which the notebook will be created.

[required] The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

[required] The name of the prepared statement.

[required] The name of the workgroup to which the prepared statement belongs.

[required] The query string for the prepared statement.

The description of the prepared statement.

[required] The session ID.

[required] The workgroup name.

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

The workgroup description.

A list of comma separated tags to add to the workgroup that is created.

[required] The name of the capacity reservation to delete.

[required] The name of the data catalog to delete.

Deletes the Athena Data Catalog. You can only use this with the FEDERATED catalogs. You usually perform this before registering the connector with Glue Data Catalog. After deletion, you will have to manage the Glue Connection and Lambda function.

[required] The unique ID of the query to delete.

[required] The ID of the notebook to delete.

[required] The name of the prepared statement to delete.

[required] The workgroup to which the statement to be deleted belongs.

[required] The unique name of the workgroup to delete.

The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.

[required] The ID of the notebook to export.

[required] The calculation execution UUID.

[required] The calculation execution UUID.

[required] The calculation execution UUID.

[required] The name of the capacity reservation to retrieve the capacity assignment configuration for.

[required] The name of the capacity reservation.

[required] The name of the data catalog to return.

The name of the workgroup. Required if making an IAM Identity Center request.

[required] The name of the data catalog that contains the database to return.

[required] The name of the database to return.

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

[required] The unique ID of the query. Use list_named_queries to get query IDs.

[required] The ID of the notebook whose metadata is to be retrieved.

[required] The name of the prepared statement to retrieve.

[required] The workgroup to which the statement to be retrieved belongs.

[required] The unique ID of the query execution.

[required] The unique ID of the query execution.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

The maximum number of results (rows) to return in this request.

When you set this to DATA_ROWS or empty, get_query_results returns the query results in rows. If set to DATA_MANIFEST, it returns the manifest file in rows. Only the query types ⁠CREATE TABLE AS SELECT⁠, UNLOAD, and INSERT can generate a manifest file. If you use DATA_MANIFEST for other query types, the query will fail.

[required] The unique ID of the query execution.

[required] The The Amazon Resource Name (ARN) for a session.

[required] The session ID.

[required] The session ID.

[required] The session ID.

[required] The name of the data catalog that contains the database and table metadata to return.

[required] The name of the database that contains the table metadata to return.

[required] The name of the table for which metadata is returned.

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

[required] The name of the workgroup.

[required] The name of the Spark enabled workgroup to import the notebook to.

[required] The name of the notebook to import.

The notebook content to be imported. The payload must be in ipynb format.

[required] The notebook content type. Currently, the only valid type is IPYNB.

A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Specifies the maximum number of results to return.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

[required] The session ID.

A filter for a specific calculation execution state. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

The maximum number of calculation executions to return.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

Specifies the maximum number of results to return.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Specifies the maximum number of data catalogs to return.

The name of the workgroup. Required if making an IAM Identity Center request.

[required] The name of the data catalog that contains the databases to return.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Specifies the maximum number of results to return.

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

The maximum number of engine versions to return in this request.

[required] The session ID.

A filter for a specific executor state. A description of each state follows.

CREATING - The executor is being started, including acquiring resources.

CREATED - The executor has been started.

REGISTERED - The executor has been registered.

TERMINATING - The executor is in the process of shutting down.

TERMINATED - The executor is no longer running.

FAILED - Due to a failure, the executor is no longer running.

The maximum number of executors to return.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

The maximum number of queries to return in this request.

The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.

Search filter string.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

Specifies the maximum number of results to return.

[required] The name of the Spark enabled workgroup to retrieve notebook metadata for.

[required] The ID of the notebook to list sessions for.

The maximum number of notebook sessions to return.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

[required] The workgroup to list the prepared statements for.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

The maximum number of results to return in this request.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

The maximum number of query executions to return in this request.

The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.

[required] The workgroup to which the session belongs.

A filter for a specific session state. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

The maximum number of sessions to return.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

[required] The name of the data catalog for which table metadata should be returned.

[required] The name of the database for which table metadata should be returned.

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Specifies the maximum number of results to return.

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

[required] Lists the tags for the resource with the specified ARN.

The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the resource with the specified ARN.

The maximum number of results to be returned per request that lists the tags for the resource.

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

The maximum number of workgroups to return in this request.

[required] The name of the capacity reservation to put a capacity assignment configuration for.

[required] The list of assignments for the capacity assignment configuration.

[required] The session ID.

A description of the calculation.

Contains configuration information for the calculation.

A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

[required] The SQL query statements to be executed.

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another start_query_execution request is received, the same response is returned and another query is not created. An error is returned if a parameter, such as QueryString, has changed. A call to start_query_execution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

The database within which the query executes.

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

The name of the workgroup in which the query is being started.

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

Specifies the query result reuse behavior for the query.

The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

To specify minimum and maximum DPU values for Capacity Reservations queries, the workgroup containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties, with the only allowed properties as max-dpu-count and min-dpu-count.

The session description.

[required] The workgroup to which the session belongs.

[required] Contains engine data processing unit (DPU) configuration settings and parameter mappings.

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is ⁠Athena notebook version 1⁠. If you specify a value for NotebookVersion, you must also specify a value for NotebookId. See EngineConfiguration$AdditionalConfigs.

The idle timeout in minutes for the session.

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

A list of comma separated tags to add to the session that is created.

Copies the tags from the Workgroup to the Session when.

[required] The calculation execution UUID.

[required] The unique ID of the query execution to stop.

[required] Specifies the ARN of the Athena resource to which tags are to be added.

[required] A collection of one or more tags, separated by commas, to be added to an Athena resource.

[required] The session ID.

[required] Specifies the ARN of the resource from which tags are to be removed.

[required] A comma-separated list of one or more tag keys whose tags are to be removed from the specified resource.

[required] The new number of requested data processing units.

[required] The name of the capacity reservation.

[required] The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

[required] Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

New or modified text that describes the data catalog.

Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type.

• For the HIVE data catalog type, use the following syntax. The ⁠metadata-function⁠ parameter is required. ⁠The sdk-version⁠ parameter is optional and defaults to the currently supported version.

  ⁠metadata-function=lambda_arn, sdk-version=version_number ⁠

• For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

  • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

    ⁠metadata-function=lambda_arn, record-function=lambda_arn ⁠

  • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

    ⁠function=lambda_arn ⁠

[required] The unique identifier (UUID) of the query.

[required] The name of the query.

The query description.

[required] The contents of the query with all query statements.

[required] The ID of the notebook to update.

[required] The updated content for the notebook.

[required] The notebook content type. Currently, the only valid type is IPYNB.

The active notebook session ID. Required if the notebook has an active session.

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

[required] The ID of the notebook to update the metadata for.

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

[required] The name to update the notebook to.

[required] The name of the prepared statement.

[required] The workgroup for the prepared statement.

[required] The query string for the prepared statement.

The description of the prepared statement.

[required] The specified workgroup that will be updated.

The workgroup description.

Contains configuration updates for an Athena SQL workgroup.

The workgroup state that will be updated for the given workgroup.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] The index field and field options you want to configure.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] The name of the analysis scheme you want to delete.

[required] The name of the domain you want to permanently delete.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] The name of the Expression to delete.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] The name of the index field your want to remove from the domain's indexing options.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] Specifies the name of the suggester you want to delete.

[required] The name of the domain you want to describe.

The analysis schemes you want to describe.

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

[required] The name of the domain you want to describe.

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

[required] A string that represents the name of a domain.

Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

The names of the domains you want to include in the response.

[required] The name of the domain you want to describe.

Limits the describe_expressions response to the specified expressions. If not specified, all expressions are shown.

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

[required] The name of the domain you want to describe.

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] The name of the domain you want to describe.

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

[required] The name of the domain you want to describe.

The suggesters you want to describe.

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

[required] A string that represents the name of a domain.

[required] Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] The desired instance type and desired number of replicas of each index partition.

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

[required] The access rules you want to configure. These rules replace any existing rules.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

Retrieves a cursor value you can use to page through large result sets. Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.

You specify the expressions in JSON using the form {"EXPRESSIONNAME":"EXPRESSION"}. You can define and use multiple expressions in a search request. For example:

⁠{"expression1":"_score*rating", "expression2":"(1/rank)*year"}⁠

For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide.

Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form ⁠{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}⁠.

You can specify the following faceting options:

• buckets specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see Searching for a Range of Values in the Amazon CloudSearch Developer Guide. Buckets are returned in the order they are specified in the request. The sort and size options are not valid if you specify buckets.

• size specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The size parameter is only valid when you specify the sort option; it cannot be used in conjunction with buckets.

• sort specifies how you want to sort the facets in the results: bucket or count. Specify bucket to sort alphabetically or numerically by facet value (in ascending order). Specify count to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the buckets option instead of sort.

If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.

To count particular buckets of values, use the buckets option. For example, the following request uses the buckets option to calculate and return facet counts by decade.

⁠\{"year":\{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,\}"]\}\}⁠

To sort facets by facet count, use the count option. For example, the following request sets the sort option to count to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the size option to 3 returns only the top three facet values.

⁠{"year":{"sort":"count","size":3}}⁠

To sort the facets by value, use the bucket option. For example, the following request sets the sort option to bucket to sort the facet values numerically by year, with earliest year listed first.

{"year":{"sort":"bucket"}}

For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.

Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax.

For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.

Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form ⁠{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}⁠.

You can specify the following highlight options:

• format: specifies the format of the data in the text field: text or html. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is html.

• max_phrases: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted.

• pre_tag: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is ⁠<em>⁠. The default for text highlights is *.

• post_tag: specifies the string to append to an occurrence of a search term. The default for HTML highlights is ⁠</em>⁠. The default for text highlights is *.

If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: ⁠<em>search-term</em>⁠.

For example, the following request retrieves highlights for the actors and title fields.

⁠{ "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "","post_tag": ""} }⁠

Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.

[required] Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the queryOptions parameter. By default, the simple query parser is used to process requests. To use the structured, lucene, or dismax query parser, you must also specify the queryParser parameter.

For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.

Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form ⁠{\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.⁠

The options you can configure vary according to which parser you use:

• defaultOperator: The default operator used to combine individual terms in the search string. For example: defaultOperator: 'or'. For the dismax parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of ⁠0%⁠ is the equivalent to OR, and a value of ⁠100%⁠ is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, ⁠defaultOperator: 50%⁠. Valid values: and, or, a percentage in the range 0%-100% (dismax). Default: and (simple, structured, lucene) or 100 (dismax). Valid for: simple, structured, lucene, and dismax.

• fields: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost the importance of the title field over the description field you could specify: ⁠"fields":["title^5","description"]⁠. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All text and text-array fields. Valid for: simple, structured, lucene, and dismax.

• operators: An array of the operators or special characters you want to disable for the simple query parser. If you disable the and, or, or not operators, the corresponding operators (+, |, -) have no special meaning and are dropped from the search string. Similarly, disabling prefix disables the wildcard operator (*) and disabling phrase disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling near disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the fuzzy operator disables the ability to use the ~ operator to perform a fuzzy search. escape disables the ability to use a backslash (⁠\⁠) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietname

• phraseFields: An array of the text or text-array fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The phraseSlop option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost phrase matches in the title field over the abstract field, you could specify: ⁠"phraseFields":["title^3", "plot"]⁠ Valid values: The name of any text or text-array field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with phraseFields, proximity scoring is disabled even if phraseSlop is specified. Valid for: dismax.

• phraseSlop: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the phraseFields option; for example, phraseSlop: 2. You must also specify phraseFields to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: dismax.

• explicitPhraseSlop: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify "explicitPhraseSlop":3. Valid values: positive integers. Default: 0. Valid for: dismax.

• tieBreaker: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a tieBreaker value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is ⁠(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)⁠. Set tieBreaker to 0 to disregard all but the highest scoring field (pure max): "tieBreaker":0. Set to 1 to sum the scores from all fields (pure sum): "tieBreaker":1. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: dismax

Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query parser.

Amazon CloudSearch supports four query parsers:

• simple: perform simple searches of text and text-array fields. By default, the simple query parser searches all text and text-array fields. You can specify which fields to search by with the queryOptions parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the queryOptions parameter.) You can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see Searching for Text in the Amazon CloudSearch Developer Guide.

• structured: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, matchall, and near. For more information, see Constructing Compound Queries in the Amazon CloudSearch Developer Guide.

• lucene: search using the Apache Lucene query parser syntax. For more information, see Apache Lucene Query Parser Syntax.

• dismax: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see DisMax Query Parser Syntax.

Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (⁠_all_fields⁠). To return only the document IDs for the matching documents, specify ⁠_no_fields⁠. To retrieve the relevance score calculated for each document, specify ⁠_score⁠.

Specifies the maximum number of search hits to include in the response.

Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (asc or desc) for each field; for example, ⁠year desc,title asc⁠. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no sort parameter is specified, results are sorted by their default relevance scores in descending order: ⁠_score desc⁠. You can also sort by document ID (⁠_id asc⁠) and version (⁠_version desc⁠).

For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.

Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:

⁠{"FIELD-A":{},"FIELD-B":{}}⁠

There are currently no options supported for statistics.

[required] Specifies the string for which you want to get suggestions.

[required] Specifies the name of the suggester to use to find suggested matches.

Specifies the maximum number of suggestions to return.

[required] A batch of documents formatted in JSON or HTML.

[required] The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

• application/json

• application/xml

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The ID of the pipeline.

A list of parameter values to pass to the pipeline at activation.

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

[required] The ID of the pipeline.

[required] The tags to add, as key/value pairs.

[required] The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

[required] A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to create_pipeline. For example, if the first call to create_pipeline does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to create_pipeline. create_pipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.

The description for the pipeline.

A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

[required] The ID of the pipeline.

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

[required] The ID of the pipeline.

[required] The ID of the pipeline that contains the object definitions.

[required] The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to describe_objects.

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call describe_objects with the marker value from the previous call to retrieve the next set of results.

[required] The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call list_pipelines.

[required] The ID of the pipeline.

[required] The ID of the object.

[required] The expression to evaluate.

[required] The ID of the pipeline.

The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call list_pipelines with the marker value from the previous call to retrieve the next set of results.

[required] The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to poll_for_task. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

The public DNS name of the calling task runner.

Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using ⁠http://169.254.169.254/latest/meta-data/instance-id⁠. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

[required] The ID of the pipeline.

[required] The objects that define the pipeline. These objects overwrite the existing pipeline definition.

The parameter objects used with the pipeline.

The parameter values used with the pipeline.

[required] The ID of the pipeline.

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

[required] Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call query_objects with the marker value from the previous call to retrieve the next set of results.

The maximum number of object names that query_objects will return in a single call. The default value is 100.

[required] The ID of the pipeline.

[required] The keys of the tags to remove.

[required] The ID of the task assigned to the task runner. This value is provided in the response for poll_for_task.

Key-value pairs that define the properties of the ReportTaskProgressInput object.

[required] The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

The public DNS name of the task runner.

[required] The ID of the pipeline that contains the objects.

[required] The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

[required] The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

[required] The ID of the task assigned to the task runner. This value is provided in the response for poll_for_task.

[required] If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

[required] The ID of the pipeline.

[required] The objects that define the pipeline changes to validate against the pipeline.

The parameter objects used with the pipeline.

The parameter values used with the pipeline.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The identifier of the Amazon DataZone domain.

[required] The identifier of the asset.

The revision that is to be made to the asset.

Specifies the rule (or the conditions) under which a prediction can be accepted.

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

[required] The Amazon DataZone domain where the specified subscription request is being accepted.

[required] The unique identifier of the subscription request that is to be accepted.

A description that specifies the reason for accepting the specified subscription request.

The asset scopes of the accept subscription request.

The asset permissions of the accept subscription request.

[required] The ID of the domain in which you want to add the entity owner.

[required] The type of an entity.

[required] The ID of the entity to which you want to add an owner.

[required] The owner that you want to add to the entity.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the domain where you want to add a policy grant.

[required] The type of entity (resource) to which the grant is added.

[required] The ID of the entity (resource) to which you want to add a policy grant.

[required] The type of policy that you want to grant.

[required] The principal to whom the permissions are granted.

[required] The details of the policy grant.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the Amazon DataZone domain in which the environment role is associated.

[required] The ID of the Amazon DataZone environment.

[required] The ARN of the environment role.

[required] The ID of the domain where governed terms are to be associated with an asset.

[required] The ID of the asset with which you want to associate a governed term.

[required] The type of the asset with which you want to associate a governed term.

[required] The glossary terms in a restricted glossary.

[required] The domain ID where you want to get the attribute metadata.

[required] The entity type for which you want to get attribute metadata.

[required] The entity ID for which you want to get attribute metadata.

The entity revision for which you want to get attribute metadata.

[required] The attribute identifier.

[required] The domain ID where you want to write the attribute metadata.

[required] The entity type for which you want to write the attribute metadata.

[required] The entity ID for which you want to write the attribute metadata.

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

[required] The attributes of the metadata.

[required] The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.

[required] The ID of the metadata generation run.

[required] The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

[required] The unique identifier of the subscription that is being cancelled.

[required] The ID of the domain where the account pool is created.

[required] The name of the account pool.

The description of the account pool.

[required] The mechanism used to resolve the account selection from the account pool.

[required] The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

[required] Asset name.

[required] Amazon DataZone domain where the asset is created.

The external identifier of the asset.

If the value for the externalIdentifier parameter is specified, it must be a unique value.

[required] The unique identifier of this asset's type.

The revision of this asset's type.

Asset description.

Glossary terms attached to the asset.

Metadata forms attached to the asset.

[required] The unique identifier of the project that owns this asset.

The configuration of the automatically generated business-friendly metadata for the asset.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the domain in which you want to create an asset filter.

[required] The ID of the data asset.

[required] The name of the asset filter.

The description of the asset filter.

[required] The configuration of the asset filter.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] Te revised name of the asset.

[required] The unique identifier of the domain where the asset is being revised.

[required] The identifier of the asset.

The revision type of the asset.

The revised description of the asset.

The glossary terms to be attached to the asset as part of asset revision.

The metadata forms to be attached to the asset as part of asset revision.

The configuration of the automatically generated business-friendly metadata for the asset.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The unique identifier of the Amazon DataZone domain where the custom asset type is being created.

[required] The name of the custom asset type.

The descripton of the custom asset type.

[required] The metadata forms that are to be attached to the custom asset type.

[required] The identifier of the Amazon DataZone project that is to own the custom asset type.

The location where the connection is created.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

The configurations of the connection.

A connection description.

[required] The ID of the domain where the connection is created.

The ID of the environment where the connection is created.

[required] The connection name.

The connection props.

Specifies whether the trusted identity propagation is enabled.

The scope of the connection.

[required] The ID of the domain where the data product is created.

[required] The name of the data product.

[required] The ID of the owning project of the data product.

The description of the data product.

The glossary terms of the data product.

The metadata forms of the data product.

The data assets of the data product.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the domain where the data product revision is created.

[required] The ID of the data product revision.

[required] The name of the data product revision.

The description of the data product revision.

The glossary terms of the data product revision.

The data assets of the data product revision.

The metadata forms of the data product revision.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The name of the data source.

The description of the data source.

[required] The ID of the Amazon DataZone domain where the data source is created.

[required] The identifier of the Amazon DataZone project in which you want to add this data source.

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

The ID of the connection.

[required] The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift.

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

Specifies whether the business name generation is to be enabled for this data source.

Specifies whether the data source is enabled.

The schedule of the data source runs.

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

The metadata forms that are to be attached to the assets that this data source works with.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The name of the Amazon DataZone domain.

The description of the Amazon DataZone domain.

The single-sign on configuration of the Amazon DataZone domain.

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

The tags specified for the Amazon DataZone domain.

The version of the domain that is created.

The service role of the domain that is created.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the domain where you want to crate a domain unit.

[required] The name of the domain unit.

[required] The ID of the parent domain unit.

The description of the domain unit.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The identifier of the Amazon DataZone project in which this environment is created.

[required] The identifier of the Amazon DataZone domain in which the environment is created.

The description of the Amazon DataZone environment.

[required] The name of the Amazon DataZone environment.

The identifier of the environment profile that is used to create this Amazon DataZone environment.

The user parameters of this Amazon DataZone environment.

The glossary terms that can be used in this Amazon DataZone environment.

The ID of the account in which the environment is being created.

The region of the account in which the environment is being created.

The ID of the blueprint with which the environment is being created.

The deployment order of the environment.

The configuration ID of the environment.

The configuration name of the environment.

[required] The ID of the Amazon DataZone domain in which the environment action is created.

[required] The ID of the environment in which the environment action is created.

[required] The name of the environment action.

[required] The parameters of the environment action.

The description of the environment action that is being created in the environment.

[required] The identifier of the domain in which this blueprint is created.

[required] The name of this Amazon DataZone blueprint.

The description of the Amazon DataZone blueprint.

[required] The provisioning properties of this Amazon DataZone blueprint.

The user parameters of this Amazon DataZone blueprint.

[required] The ID of the Amazon DataZone domain in which this environment profile is created.

[required] The name of this Amazon DataZone environment profile.

The description of this Amazon DataZone environment profile.

[required] The ID of the blueprint with which this environment profile is created.

[required] The identifier of the project in which to create the environment profile.

The user parameters of this Amazon DataZone environment profile.

The Amazon Web Services account in which the Amazon DataZone environment is created.

The Amazon Web Services region in which this environment profile is created.

[required] The ID of the Amazon DataZone domain in which this metadata form type is created.

[required] The name of this Amazon DataZone metadata form type.

[required] The model of this Amazon DataZone metadata form type.

[required] The ID of the Amazon DataZone project that owns this metadata form type.

The status of this Amazon DataZone metadata form type.

The description of this Amazon DataZone metadata form type.

[required] The ID of the Amazon DataZone domain in which this business glossary is created.

[required] The name of this business glossary.

[required] The ID of the project that currently owns business glossary.

The description of this business glossary.

The status of this business glossary.

The usage restriction of the restricted glossary.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the Amazon DataZone domain in which this business glossary term is created.

[required] The ID of the business glossary in which this term is created.

[required] The name of this business glossary term.

The status of this business glossary term.

The short description of this business glossary term.

The long description of this business glossary term.

The term relations of this business glossary term.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The identifier of the Amazon DataZone domain in which the group profile is created.

The identifier of the group for which the group profile is created.

The ARN of the IAM role that will be associated with the group profile. This role defines the permissions that group members will assume when accessing Amazon DataZone resources.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the Amazon DataZone domain.

[required] The ID of the asset.

[required] The type of an entity.

The revision of an asset.

[required] Specifies whether to publish or unpublish a listing.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The identifier of the Amazon SageMaker Unified Studio domain in which to create the notebook.

[required] The identifier of the project that owns the notebook.

[required] The name of the notebook. The name must be between 1 and 256 characters.

The description of the notebook.

The metadata for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

The sensitive parameters for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

[required] The ID of the Amazon DataZone domain in which this project is created.

[required] The name of the Amazon DataZone project.

The description of the Amazon DataZone project.

The resource tags of the project.

The glossary terms that can be used in this Amazon DataZone project.

The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

The ID of the project profile.

The user parameters of the project.

The category of the project. Set to 'ADMIN' designates this as an administrative project for the Amazon DataZone domain.

The default project IAM role that is used to access project resources and run computes such as Glue and Sagemaker.

The members to be assigned to the project.

[required] The ID of the Amazon DataZone domain in which project membership is created.

[required] The ID of the project for which this project membership was created.

[required] The project member whose project membership was created.

[required] The designation of the project membership.

[required] A domain ID of the project profile.

[required] Project profile name.

A description of a project profile.

Project profile status.

The resource tags of the project profile.

Specifies whether custom project resource tags are supported.

Field viewable through the UI that provides a project user with the allowed resource tag specifications.

Environment configurations of the project profile.

A domain unit ID of the project profile.

[required] The ID of the domain where the rule is created.

[required] The name of the rule.

[required] The target of the rule.

[required] The action of the rule.

[required] The scope of the rule.

[required] The detail of the rule.

The description of the rule.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the Amazon DataZone domain in which the subscription grant is created.

[required] The ID of the environment in which the subscription grant is created.

The ID of the subscription target for which the subscription grant is created.

[required] The entity to which the subscription is to be granted.

The names of the assets for which the subscription grant is created.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the Amazon DataZone domain in which the subscription request is created.

[required] The Amazon DataZone principals for whom the subscription request is created.

[required] The published asset for which the subscription grant is to be created.

[required] The reason for the subscription request.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

The metadata form included in the subscription request.

The asset permissions of the subscription request.

The asset scopes of the subscription request.

[required] The ID of the Amazon DataZone domain in which subscription target is created.

[required] The ID of the environment in which subscription target is created.

[required] The name of the subscription target.

[required] The type of the subscription target.

[required] The configuration of the subscription target.

[required] The authorized principals of the subscription target.

[required] The manage access role that is used to create the subscription target.

[required] The asset types that can be included in the subscription target.

The provider of the subscription target.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

[required] The identifier of the Amazon DataZone domain in which a user profile is created.

[required] The identifier of the user for which the user profile is created.

The user type of the user for which the user profile is created.

The session name for IAM role sessions.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

[required] The ID of the domain where the account pool is deleted.

[required] The ID of the account pool to be deleted.

[required] The ID of the Amazon DataZone domain in which the asset is deleted.

[required] The identifier of the asset that is deleted.

[required] The ID of the domain where you want to delete an asset filter.

[required] The ID of the data asset.

[required] The ID of the asset filter that you want to delete.

[required] The ID of the Amazon DataZone domain in which the asset type is deleted.

[required] The identifier of the asset type that is deleted.

[required] The ID of the domain where the connection is deleted.

[required] The ID of the connection that is deleted.

[required] The domain ID for which you want to delete the data export configuration.

[required] The ID of the Amazon DataZone domain in which the data product is deleted.

[required] The identifier of the data product that is deleted.

[required] The ID of the Amazon DataZone domain in which the data source is deleted.

[required] The identifier of the data source that is deleted.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

[required] The identifier of the Amazon Web Services domain that is to be deleted.

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Specifies the optional flag to delete all child entities within the domain.

[required] The ID of the domain where you want to delete a domain unit.

[required] The ID of the domain unit that you want to delete.

[required] The ID of the Amazon DataZone domain in which the environment is deleted.

[required] The identifier of the environment that is to be deleted.

[required] The ID of the Amazon DataZone domain in which an environment action is deleted.

[required] The ID of the environment where an environment action is deleted.

[required] The ID of the environment action that is deleted.

[required] The ID of the Amazon DataZone domain in which the blueprint is deleted.

[required] The ID of the blueprint that is deleted.

[required] The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.

[required] The ID of the blueprint the configuration of which is deleted.

[required] The ID of the Amazon DataZone domain in which the environment profile is deleted.

[required] The ID of the environment profile that is deleted.

[required] The ID of the Amazon DataZone domain in which the metadata form type is deleted.