From e6160c9846d4f72e5d09a2c6160b1cd1770b5bad Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Tue, 3 Dec 2024 19:06:09 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/athena.json | 259 +- .../aws-models/bedrock-agent-runtime.json | 429 + .../sdk-codegen/aws-models/bedrock-agent.json | 852 +- .../aws-models/bedrock-runtime.json | 918 +- codegen/sdk-codegen/aws-models/bedrock.json | 271 +- .../sdk-codegen/aws-models/cloudwatch.json | 8 +- codegen/sdk-codegen/aws-models/datazone.json | 8069 ++++++++++++++--- codegen/sdk-codegen/aws-models/dsql.json | 1920 ++++ codegen/sdk-codegen/aws-models/dynamodb.json | 54 +- codegen/sdk-codegen/aws-models/glue.json | 4653 +++++++++- .../sdk-codegen/aws-models/lakeformation.json | 56 +- codegen/sdk-codegen/aws-models/qapps.json | 225 +- codegen/sdk-codegen/aws-models/qbusiness.json | 2066 ++++- .../sdk-codegen/aws-models/quicksight.json | 1078 ++- .../aws-models/redshift-serverless.json | 199 +- codegen/sdk-codegen/aws-models/redshift.json | 242 +- codegen/sdk-codegen/aws-models/s3.json | 346 + codegen/sdk-codegen/aws-models/s3tables.json | 3882 ++++++++ 18 files changed, 23955 insertions(+), 1572 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/dsql.json create mode 100644 codegen/sdk-codegen/aws-models/s3tables.json diff --git a/codegen/sdk-codegen/aws-models/athena.json b/codegen/sdk-codegen/aws-models/athena.json index 08f551e64eb..ef1fc609c7c 100644 --- a/codegen/sdk-codegen/aws-models/athena.json +++ b/codegen/sdk-codegen/aws-models/athena.json @@ -2172,6 +2172,131 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.athena#ConnectionType": { + "type": "enum", + "members": { + "DYNAMODB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB" + } + }, + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + }, + "ORACLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE" + } + }, + "SYNAPSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNAPSE" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + }, + "DB2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DB2" + } + }, + "OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH" + } + }, + "BIGQUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGQUERY" + } + }, + "GOOGLECLOUDSTORAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLECLOUDSTORAGE" + } + }, + "HBASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HBASE" + } + }, + "DOCUMENTDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENTDB" + } + }, + "CMDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMDB" + } + }, + "TPCDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TPCDS" + } + }, + "TIMESTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTREAM" + } + }, + "SAPHANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAPHANA" + } + }, + "SNOWFLAKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNOWFLAKE" + } + }, + "DATALAKEGEN2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATALAKEGEN2" + } + }, + "DB2AS400": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DB2AS400" + } + } + } + }, "com.amazonaws.athena#CoordinatorDpuSize": { "type": "integer", "traits": { @@ -2254,7 +2379,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.

" + "smithy.api#documentation": "

Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.

\n

This API operation creates the following resources.

\n " } }, "com.amazonaws.athena#CreateDataCatalogInput": { @@ -2263,14 +2388,14 @@ "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

\n

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

\n ", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { - "smithy.api#documentation": "

The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -2283,13 +2408,13 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

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

\n " + "smithy.api#documentation": "

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

\n " } }, "Tags": { "target": "com.amazonaws.athena#TagList", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -2299,7 +2424,11 @@ }, "com.amazonaws.athena#CreateDataCatalogOutput": { "type": "structure", - "members": {}, + "members": { + "DataCatalog": { + "target": "com.amazonaws.athena#DataCatalog" + } + }, "traits": { "smithy.api#output": {} } @@ -2675,14 +2804,32 @@ "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { - "smithy.api#documentation": "

The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

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

\n " + "smithy.api#documentation": "

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

\n " + } + }, + "Status": { + "target": "com.amazonaws.athena#DataCatalogStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation or deletion of the data catalog.

\n \n

Data catalog creation status:

\n \n

Data catalog deletion status:

\n " + } + }, + "ConnectionType": { + "target": "com.amazonaws.athena#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of connection for a FEDERATED data catalog (for example,\n REDSHIFT, MYSQL, or SQLSERVER). For\n information about individual connectors, see Available data source\n connectors.

" + } + }, + "Error": { + "target": "com.amazonaws.athena#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Text of the error that occurred during data catalog creation or deletion.

" } } }, @@ -2690,6 +2837,65 @@ "smithy.api#documentation": "

Contains information about a data catalog in an Amazon Web Services account.

\n \n

In the Athena console, data catalogs are listed as \"data sources\" on\n the Data sources page under the Data source name column.

\n " } }, + "com.amazonaws.athena#DataCatalogStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_COMPLETE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "CREATE_FAILED_CLEANUP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_IN_PROGRESS" + } + }, + "CREATE_FAILED_CLEANUP_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_COMPLETE" + } + }, + "CREATE_FAILED_CLEANUP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_FAILED" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_COMPLETE" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, "com.amazonaws.athena#DataCatalogSummary": { "type": "structure", "members": { @@ -2704,6 +2910,24 @@ "traits": { "smithy.api#documentation": "

The data catalog type.

" } + }, + "Status": { + "target": "com.amazonaws.athena#DataCatalogStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation or deletion of the data catalog.

\n \n

Data catalog creation status:

\n \n

Data catalog deletion status:

\n " + } + }, + "ConnectionType": { + "target": "com.amazonaws.athena#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of connection for a FEDERATED data catalog (for example,\n REDSHIFT, MYSQL, or SQLSERVER). For\n information about individual connectors, see Available data source\n connectors.

" + } + }, + "Error": { + "target": "com.amazonaws.athena#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Text of the error that occurred during data catalog creation or deletion.

" + } } }, "traits": { @@ -2736,6 +2960,12 @@ "traits": { "smithy.api#enumValue": "HIVE" } + }, + "FEDERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FEDERATED" + } } } }, @@ -2879,6 +3109,13 @@ "smithy.api#documentation": "

The name of the data catalog to delete.

", "smithy.api#required": {} } + }, + "DeleteCatalogOnly": { + "target": "com.amazonaws.athena#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

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

" + } } }, "traits": { @@ -2887,7 +3124,11 @@ }, "com.amazonaws.athena#DeleteDataCatalogOutput": { "type": "structure", - "members": {}, + "members": { + "DataCatalog": { + "target": "com.amazonaws.athena#DataCatalog" + } + }, "traits": { "smithy.api#output": {} } diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json index 95696942aa4..34df34e97bf 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json @@ -21,6 +21,15 @@ "smithy.api#documentation": "

\n Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.\n You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.\n

" } }, + "com.amazonaws.bedrockagentruntime#AWSResourceARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" + } + }, "com.amazonaws.bedrockagentruntime#AccessDeniedException": { "type": "structure", "members": { @@ -248,6 +257,15 @@ "target": "com.amazonaws.bedrockagentruntime#AgentActionGroup" } }, + "com.amazonaws.bedrockagentruntime#AgentAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" + } + }, "com.amazonaws.bedrockagentruntime#AgentAliasId": { "type": "string", "traits": { @@ -257,6 +275,116 @@ "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorInputPayload": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#PayloadType", + "traits": { + "smithy.api#documentation": "

The input type.

" + } + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString", + "traits": { + "smithy.api#documentation": "

Input text.

" + } + }, + "returnControlResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlResults", + "traits": { + "smithy.api#documentation": "

An action invocation result.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for an agent collaborator. The input can be text or an action invocation result.

" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationInput": { + "type": "structure", + "members": { + "agentCollaboratorName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The collaborator's name.

" + } + }, + "agentCollaboratorAliasArn": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", + "traits": { + "smithy.api#documentation": "

The collaborator's alias ARN.

" + } + }, + "input": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInputPayload", + "traits": { + "smithy.api#documentation": "

Text or action invocation result input for the collaborator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An agent collaborator invocation input.

" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationOutput": { + "type": "structure", + "members": { + "agentCollaboratorName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The output's agent collaborator name.

" + } + }, + "agentCollaboratorAliasArn": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", + "traits": { + "smithy.api#documentation": "

The output's agent collaborator alias ARN.

" + } + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorOutputPayload", + "traits": { + "smithy.api#documentation": "

The output's output.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output from an agent collaborator.

" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorOutputPayload": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#PayloadType", + "traits": { + "smithy.api#documentation": "

The type of output.

" + } + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString", + "traits": { + "smithy.api#documentation": "

Text output.

" + } + }, + "returnControlPayload": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlPayload", + "traits": { + "smithy.api#documentation": "

An action invocation result.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output from an agent collaborator. The output can be text or an action invocation result.

" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#AgentId": { "type": "string", "traits": { @@ -1050,6 +1178,18 @@ "traits": { "smithy.api#documentation": "

Contains information about the API operation to invoke.

" } + }, + "agentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The agent's ID.

" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "

The agent collaborator's name.

" + } } }, "traits": { @@ -1153,6 +1293,12 @@ "traits": { "smithy.api#documentation": "

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

" } + }, + "agentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The agent's ID.

" + } } }, "traits": { @@ -1358,6 +1504,26 @@ "smithy.api#documentation": "

The property contains the file to chat with, along with its attributes.

" } }, + "com.amazonaws.bedrockagentruntime#Caller": { + "type": "union", + "members": { + "agentAliasArn": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", + "traits": { + "smithy.api#documentation": "

The caller's agent alias ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a caller.

" + } + }, + "com.amazonaws.bedrockagentruntime#CallerChain": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Caller" + } + }, "com.amazonaws.bedrockagentruntime#Citation": { "type": "structure", "members": { @@ -1480,6 +1646,27 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.bedrockagentruntime#ContentBlock": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The block's text.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A content block.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#ContentBlock" + } + }, "com.amazonaws.bedrockagentruntime#ContentBody": { "type": "structure", "members": { @@ -1509,6 +1696,37 @@ "smithy.api#pattern": "[a-z]{1,20}/.{1,20}" } }, + "com.amazonaws.bedrockagentruntime#ConversationHistory": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.bedrockagentruntime#Messages", + "traits": { + "smithy.api#documentation": "

The conversation's messages.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A conversation history.

" + } + }, + "com.amazonaws.bedrockagentruntime#ConversationRole": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "ASSISTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assistant" + } + } + } + }, "com.amazonaws.bedrockagentruntime#CreationMode": { "type": "enum", "members": { @@ -2588,6 +2806,18 @@ "traits": { "smithy.api#documentation": "

Contains information about the function to invoke,

" } + }, + "agentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The agent's ID.

" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "

The collaborator's name.

" + } } }, "traits": { @@ -2659,6 +2889,12 @@ "traits": { "smithy.api#documentation": "

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

" } + }, + "agentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The agent's ID.

" + } } }, "traits": { @@ -4085,6 +4321,12 @@ "traits": { "smithy.api#documentation": "

Contains information about the code interpreter to be invoked.

" } + }, + "agentCollaboratorInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationInput", + "traits": { + "smithy.api#documentation": "

The collaborator's invocation input.

" + } } }, "traits": { @@ -4170,6 +4412,12 @@ "traits": { "smithy.api#enumValue": "ACTION_GROUP_CODE_INTERPRETER" } + }, + "AGENT_COLLABORATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_COLLABORATOR" + } } } }, @@ -4281,6 +4529,13 @@ "traits": { "smithy.api#documentation": "

\n Specifies the configurations for streaming.\n

" } + }, + "sourceArn": { + "target": "com.amazonaws.bedrockagentruntime#AWSResourceARN", + "traits": { + "smithy.api#documentation": "

The ARN of the resource making the request.

", + "smithy.api#httpHeader": "x-amz-source-arn" + } } }, "traits": { @@ -5009,6 +5264,34 @@ } } }, + "com.amazonaws.bedrockagentruntime#Message": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockagentruntime#ConversationRole", + "traits": { + "smithy.api#documentation": "

The message's role.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#ContentBlocks", + "traits": { + "smithy.api#documentation": "

The message's content.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a message.

" + } + }, + "com.amazonaws.bedrockagentruntime#Messages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Message" + } + }, "com.amazonaws.bedrockagentruntime#Metadata": { "type": "structure", "members": { @@ -5154,6 +5437,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.

" } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of a foundation model.

" + } } }, "traits": { @@ -5161,6 +5450,13 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#NextToken": { "type": "string", "traits": { @@ -5263,6 +5559,12 @@ "smithy.api#documentation": "

Contains the JSON-formatted string returned by the API invoked by the action group.

" } }, + "agentCollaboratorInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationOutput", + "traits": { + "smithy.api#documentation": "

A collaborator's invocation output.

" + } + }, "knowledgeBaseLookupOutput": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput", "traits": { @@ -5770,6 +6072,23 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#PayloadType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, "com.amazonaws.bedrockagentruntime#PostProcessingModelInvocationOutput": { "type": "structure", "members": { @@ -7683,6 +8002,86 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#ReturnControlResults": { + "type": "structure", + "members": { + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The action's invocation ID.

" + } + }, + "returnControlInvocationResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", + "traits": { + "smithy.api#documentation": "

The action invocation result.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An action invocation result.

" + } + }, + "com.amazonaws.bedrockagentruntime#RoutingClassifierModelInvocationOutput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The invocation's trace ID.

" + } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse", + "traits": { + "smithy.api#documentation": "

The invocation's raw response.

" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "

The invocation's metadata.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Invocation output from a routing classifier model.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RoutingClassifierTrace": { + "type": "union", + "members": { + "invocationInput": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInput", + "traits": { + "smithy.api#documentation": "

The classifier's invocation input.

" + } + }, + "observation": { + "target": "com.amazonaws.bedrockagentruntime#Observation", + "traits": { + "smithy.api#documentation": "

The classifier's observation.

" + } + }, + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "

The classifier's model invocation input.

" + } + }, + "modelInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#RoutingClassifierModelInvocationOutput", + "traits": { + "smithy.api#documentation": "

The classifier's model invocation output.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A trace for a routing classifier.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#S3BucketName": { "type": "string", "traits": { @@ -7850,6 +8249,12 @@ "traits": { "smithy.api#documentation": "

An array of configurations, each of which applies to a knowledge base attached to the agent.

" } + }, + "conversationHistory": { + "target": "com.amazonaws.bedrockagentruntime#ConversationHistory", + "traits": { + "smithy.api#documentation": "

The state's conversation history.

" + } } }, "traits": { @@ -8112,6 +8517,12 @@ "smithy.api#documentation": "

Details about the post-processing step, in which the agent shapes the response..

" } }, + "routingClassifierTrace": { + "target": "com.amazonaws.bedrockagentruntime#RoutingClassifierTrace", + "traits": { + "smithy.api#documentation": "

A routing classifier's trace.

" + } + }, "failureTrace": { "target": "com.amazonaws.bedrockagentruntime#FailureTrace", "traits": { @@ -8177,6 +8588,18 @@ "traits": { "smithy.api#documentation": "

The version of the agent.

" } + }, + "callerChain": { + "target": "com.amazonaws.bedrockagentruntime#CallerChain", + "traits": { + "smithy.api#documentation": "

The part's caller chain.

" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "

The part's collaborator name.

" + } } }, "traits": { @@ -8193,6 +8616,12 @@ "smithy.api#enumValue": "ACTION_GROUP" } }, + "AGENT_COLLABORATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_COLLABORATOR" + } + }, "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index fb516ba4fc7..ebcf3c18921 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -304,6 +304,12 @@ "traits": { "smithy.api#documentation": "

Contains memory configuration for the agent.

" } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "

The agent's collaboration settings.

" + } } }, "traits": { @@ -688,6 +694,221 @@ "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" } }, + "com.amazonaws.bedrockagent#AgentCollaboration": { + "type": "enum", + "members": { + "SUPERVISOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERVISOR" + } + }, + "SUPERVISOR_ROUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERVISOR_ROUTER" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentCollaborator": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The collaborator's agent ID.

", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "

The collaborator's agent version.

", + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "

The collaborator's agent descriptor.

", + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The collaborator's collaborator ID.

", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "

The collaborator's instructions.

", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "

The collaborator's collaborator name.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

When the collaborator was created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

When the collaborator was updated.

", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "

The collaborator's relay conversation history.

" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "

The collaborator's client token.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An agent collaborator.

" + } + }, + "com.amazonaws.bedrockagent#AgentCollaboratorResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#AssociateAgentCollaborator" + }, + { + "target": "com.amazonaws.bedrockagent#DisassociateAgentCollaborator" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentCollaborator" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentCollaborators" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentCollaborator" + } + ] + }, + "com.amazonaws.bedrockagent#AgentCollaboratorSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentCollaboratorSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentCollaboratorSummary": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The collaborator's agent ID.

", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "

The collaborator's agent version.

", + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The collaborator's ID.

", + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "

The collaborator's agent descriptor.

", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "

The collaborator's collaboration instruction.

", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "

The collaborator's relay conversation history.

", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "

The collaborator's name.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

When the collaborator was created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

When the collaborator was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An agent collaborator summary.

" + } + }, + "com.amazonaws.bedrockagent#AgentDescriptor": { + "type": "structure", + "members": { + "aliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#documentation": "

The agent's alias ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An agent descriptor.

" + } + }, "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration": { "type": "structure", "members": { @@ -1075,6 +1296,12 @@ "traits": { "smithy.api#documentation": "

\n Contains details of the memory configuration on the version of the agent. \n

" } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "

The agent's collaboration settings.

" + } } }, "traits": { @@ -1179,6 +1406,9 @@ { "target": "com.amazonaws.bedrockagent#ActionGroupResource" }, + { + "target": "com.amazonaws.bedrockagent#AgentCollaboratorResource" + }, { "target": "com.amazonaws.bedrockagent#AgentResource" }, @@ -1912,6 +2142,123 @@ "smithy.api#documentation": "

Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. For more information, see Use a tool to complete an Amazon Bedrock model response.

" } }, + "com.amazonaws.bedrockagent#AssociateAgentCollaborator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#AssociateAgentCollaboratorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#AssociateAgentCollaboratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Makes an agent a collaborator for another agent.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#AssociateAgentCollaboratorRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The agent's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "

An agent version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "

The alias of the collaborator agent.

", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "

A name for the collaborator.

", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "

Instruction for the collaborator.

", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "

A relay conversation history for the collaborator.

" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "

A client token.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#AssociateAgentCollaboratorResponse": { + "type": "structure", + "members": { + "agentCollaborator": { + "target": "com.amazonaws.bedrockagent#AgentCollaborator", + "traits": { + "smithy.api#documentation": "

Details about the collaborator.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase": { "type": "operation", "input": { @@ -2242,6 +2589,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" } }, + "com.amazonaws.bedrockagent#CollaborationInstruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration": { "type": "structure", "members": {}, @@ -2841,6 +3198,12 @@ "traits": { "smithy.api#documentation": "

Contains the details of the memory configured for the agent.

" } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "

The agent's collaboration role.

" + } } }, "traits": { @@ -5370,6 +5733,86 @@ } } }, + "com.amazonaws.bedrockagent#DisassociateAgentCollaborator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an agent collaborator.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/{collaboratorId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

An agent ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "

The agent's version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The collaborator's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { "type": "operation", "input": { @@ -5693,6 +6136,9 @@ "smithy.api#enumValue": "BINARY" } } + }, + "traits": { + "smithy.api#documentation": "

Bedrock models embedding data type. Can be either float32 or binary.

" } }, "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { @@ -7264,10 +7710,95 @@ "com.amazonaws.bedrockagent#GetAgentActionGroup": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an action group for an agent.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the agent that the action group belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "

The version of the agent that the action group belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the action group for which to get information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "

Contains details about the action group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" + "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" }, "errors": [ { @@ -7287,11 +7818,11 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about an action group for an agent.

", + "smithy.api#documentation": "

Gets information about an alias of an agent.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" }, "smithy.api#readonly": {}, "smithy.api#tags": [ @@ -7299,29 +7830,21 @@ ] } }, - "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { + "com.amazonaws.bedrockagent#GetAgentAliasRequest": { "type": "structure", "members": { "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that the action group belongs to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "

The version of the agent that the action group belongs to.

", + "smithy.api#documentation": "

The unique identifier of the agent to which the alias to get information belongs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { - "smithy.api#documentation": "

The unique identifier of the action group for which to get information.

", + "smithy.api#documentation": "

The unique identifier of the alias for which to get information.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7331,13 +7854,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { + "com.amazonaws.bedrockagent#GetAgentAliasResponse": { "type": "structure", "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", "traits": { - "smithy.api#documentation": "

Contains details about the action group.

", + "smithy.api#documentation": "

Contains information about the alias.

", "smithy.api#required": {} } } @@ -7346,13 +7869,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#GetAgentAlias": { + "com.amazonaws.bedrockagent#GetAgentCollaborator": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" + "target": "com.amazonaws.bedrockagent#GetAgentCollaboratorRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" + "target": "com.amazonaws.bedrockagent#GetAgentCollaboratorResponse" }, "errors": [ { @@ -7372,11 +7895,11 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about an alias of an agent.

", + "smithy.api#documentation": "

Retrieves information about an agent's collaborator.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/{collaboratorId}/" }, "smithy.api#readonly": {}, "smithy.api#tags": [ @@ -7384,21 +7907,29 @@ ] } }, - "com.amazonaws.bedrockagent#GetAgentAliasRequest": { + "com.amazonaws.bedrockagent#GetAgentCollaboratorRequest": { "type": "structure", "members": { "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent to which the alias to get information belongs.

", + "smithy.api#documentation": "

The agent's ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "

The unique identifier of the alias for which to get information.

", + "smithy.api#documentation": "

The agent's version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The collaborator's ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7408,13 +7939,14 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GetAgentAliasResponse": { + "com.amazonaws.bedrockagent#GetAgentCollaboratorResponse": { "type": "structure", "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", + "agentCollaborator": { + "target": "com.amazonaws.bedrockagent#AgentCollaborator", "traits": { - "smithy.api#documentation": "

Contains information about the alias.

", + "smithy.api#documentation": "

Details about the collaborator.

", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } @@ -9929,6 +10461,107 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockagent#ListAgentCollaborators": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentCollaboratorsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentCollaboratorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve a list of an agent's collaborators.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentCollaboratorSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentCollaboratorsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The agent's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "

The agent's version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of agent collaborators to return in one page of results.

" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentCollaboratorsResponse": { + "type": "structure", + "members": { + "agentCollaboratorSummaries": { + "target": "com.amazonaws.bedrockagent#AgentCollaboratorSummaries", + "traits": { + "smithy.api#documentation": "

A list of collaborator summaries.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#ListAgentKnowledgeBases": { "type": "operation", "input": { @@ -12247,6 +12880,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

" } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The agent's foundation model.

" + } } }, "traits": { @@ -13046,6 +13685,23 @@ "smithy.api#pattern": "^.*$" } }, + "com.amazonaws.bedrockagent#RelayConversationHistory": { + "type": "enum", + "members": { + "TO_COLLABORATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_COLLABORATOR" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.bedrockagent#RequireConfirmation": { "type": "enum", "members": { @@ -13063,7 +13719,7 @@ } }, "traits": { - "smithy.api#documentation": "ENUM to check if action requires user confirmation" + "smithy.api#documentation": "

Whether the action requires user confirmation.

" } }, "com.amazonaws.bedrockagent#ResourceNotFoundException": { @@ -14881,6 +15537,124 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockagent#UpdateAgentCollaborator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentCollaboratorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentCollaboratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an agent's collaborator.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/{collaboratorId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentCollaboratorRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The agent's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "

The agent's version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The collaborator's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "

An agent descriptor for the agent collaborator.

", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "

The collaborator's name.

", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "

Instruction for the collaborator.

", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "

A relay conversation history for the collaborator.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentCollaboratorResponse": { + "type": "structure", + "members": { + "agentCollaborator": { + "target": "com.amazonaws.bedrockagent#AgentCollaborator", + "traits": { + "smithy.api#documentation": "

Details about the collaborator.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { "type": "operation", "input": { @@ -15067,6 +15841,12 @@ "traits": { "smithy.api#documentation": "

Specifies the new memory configuration for the agent.

" } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "

The agent's collaboration role.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-runtime.json index cc4f8c47caa..b0451101a95 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-runtime.json @@ -14,6 +14,12 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.bedrockruntime#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.bedrockruntime#AdditionalModelResponseFieldPaths": { "type": "list", "member": { @@ -35,6 +41,9 @@ "type": "service", "version": "2023-09-30", "resources": [ + { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeResource" + }, { "target": "com.amazonaws.bedrockruntime#GuardrailResource" }, @@ -756,7 +765,7 @@ } ], "traits": { - "smithy.api#documentation": "

The action to apply a guardrail.

", + "smithy.api#documentation": "

The action to apply a guardrail.

\n

For troubleshooting some of the common errors you might encounter when using the ApplyGuardrail API, \n see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

", "smithy.api#http": { "code": 200, "method": "POST", @@ -844,6 +853,195 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockruntime#AsyncInvokeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z0-9\\-]+:bedrock:[a-z0-9\\-]*:[0-9]*:(provisioned-model|foundation-model)/.+$" + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeIdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[!-~]*$" + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_\\.\\-/0-9:]+$" + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeOutputDataConfig": { + "type": "union", + "members": { + "s3OutputDataConfig": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeS3OutputDataConfig", + "traits": { + "smithy.api#documentation": "

A storage location for the output data in an S3 bucket

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Asynchronous invocation output data settings.

" + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockruntime#GetAsyncInvoke" + }, + { + "target": "com.amazonaws.bedrockruntime#ListAsyncInvokes" + }, + { + "target": "com.amazonaws.bedrockruntime#StartAsyncInvoke" + } + ] + }, + "com.amazonaws.bedrockruntime#AsyncInvokeS3OutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrockruntime#S3Uri", + "traits": { + "smithy.api#documentation": "

An object URI starting with s3://.

", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrockruntime#KmsKeyId", + "traits": { + "smithy.api#documentation": "

A KMS encryption key ID.

" + } + }, + "bucketOwner": { + "target": "com.amazonaws.bedrockruntime#AccountId", + "traits": { + "smithy.api#documentation": "

If the bucket belongs to another AWS account, specify that account's ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Asynchronous invocation output data settings.

" + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeSummary" + } + }, + "com.amazonaws.bedrockruntime#AsyncInvokeSummary": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockruntime#InvocationArn", + "traits": { + "smithy.api#documentation": "

The invocation's ARN.

", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeArn", + "traits": { + "smithy.api#documentation": "

The invoked model's ARN.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeIdempotencyToken", + "traits": { + "smithy.api#documentation": "

The invocation's idempotency token.

" + } + }, + "status": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeStatus", + "traits": { + "smithy.api#documentation": "

The invocation's status.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeMessage", + "traits": { + "smithy.api#documentation": "

An error message.

" + } + }, + "submitTime": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

When the invocation was submitted.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

When the invocation was last modified.

" + } + }, + "endTime": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

When the invocation ended.

" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeOutputDataConfig", + "traits": { + "smithy.api#documentation": "

The invocation's output data settings.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of an asynchronous invocation.

" + } + }, "com.amazonaws.bedrockruntime#AutoToolChoice": { "type": "structure", "members": {}, @@ -860,6 +1058,19 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockruntime#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

Error occurred because of a conflict while performing an operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.bedrockruntime#ContentBlock": { "type": "union", "members": { @@ -881,6 +1092,12 @@ "smithy.api#documentation": "

A document to include in the message.

" } }, + "video": { + "target": "com.amazonaws.bedrockruntime#VideoBlock", + "traits": { + "smithy.api#documentation": "

Video to include in the message.

" + } + }, "toolUse": { "target": "com.amazonaws.bedrockruntime#ToolUseBlock", "traits": { @@ -1137,7 +1354,7 @@ "toolConfig": { "target": "com.amazonaws.bedrockruntime#ToolConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for the tools that the model can use when generating a response.

\n \n

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

\n " + "smithy.api#documentation": "

Configuration information for the tools that the model can use when generating a response.

\n

For information about models that support tool use, see \n Supported models and model features.

" } }, "guardrailConfig": { @@ -1167,6 +1384,12 @@ } } }, + "requestMetadata": { + "target": "com.amazonaws.bedrockruntime#RequestMetadata", + "traits": { + "smithy.api#documentation": "

Key-value pairs that you can use to filter invocation logs.

" + } + }, "performanceConfig": { "target": "com.amazonaws.bedrockruntime#PerformanceConfiguration", "traits": { @@ -1381,13 +1604,13 @@ "validationException": { "target": "com.amazonaws.bedrockruntime#ValidationException", "traits": { - "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

" + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, \n see ValidationError in the Amazon Bedrock User Guide

" } }, "throttlingException": { "target": "com.amazonaws.bedrockruntime#ThrottlingException", "traits": { - "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

" + "smithy.api#documentation": "

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For\n troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

" } }, "serviceUnavailableException": { @@ -1434,7 +1657,7 @@ "toolConfig": { "target": "com.amazonaws.bedrockruntime#ToolConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for the tools that the model can use when generating a response.

\n \n

This field is only supported by Anthropic Claude 3 models.

\n " + "smithy.api#documentation": "

Configuration information for the tools that the model can use when generating a response.

\n

For information about models that support streaming tool use, see \n Supported models and model features.

" } }, "guardrailConfig": { @@ -1464,6 +1687,12 @@ } } }, + "requestMetadata": { + "target": "com.amazonaws.bedrockruntime#RequestMetadata", + "traits": { + "smithy.api#documentation": "

Key-value pairs that you can use to filter invocation logs.

" + } + }, "performanceConfig": { "target": "com.amazonaws.bedrockruntime#PerformanceConfiguration", "traits": { @@ -1627,6 +1856,121 @@ "smithy.api#documentation": "

Contains the content of a document.

" } }, + "com.amazonaws.bedrockruntime#GetAsyncInvoke": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#GetAsyncInvokeRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#GetAsyncInvokeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve information about an asynchronous invocation.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/async-invoke/{invocationArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockruntime#GetAsyncInvokeRequest": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockruntime#InvocationArn", + "traits": { + "smithy.api#documentation": "

The invocation's ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#GetAsyncInvokeResponse": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockruntime#InvocationArn", + "traits": { + "smithy.api#documentation": "

The invocation's ARN.

", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeArn", + "traits": { + "smithy.api#documentation": "

The invocation's model ARN.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeIdempotencyToken", + "traits": { + "smithy.api#documentation": "

The invocation's idempotency token.

" + } + }, + "status": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeStatus", + "traits": { + "smithy.api#documentation": "

The invocation's status.

", + "smithy.api#required": {} + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeMessage", + "traits": { + "smithy.api#documentation": "

An error message.

" + } + }, + "submitTime": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

When the invocation request was submitted.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

The invocation's last modified time.

" + } + }, + "endTime": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

When the invocation ended.

" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Output data settings.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockruntime#GuardrailAction": { "type": "enum", "members": { @@ -3056,6 +3400,16 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.bedrockruntime#InvocationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}$" + } + }, "com.amazonaws.bedrockruntime#InvokeModel": { "type": "operation", "input": { @@ -3361,27 +3715,163 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockruntime#Message": { - "type": "structure", - "members": { - "role": { - "target": "com.amazonaws.bedrockruntime#ConversationRole", - "traits": { - "smithy.api#documentation": "

The role that the message plays in the message.

", - "smithy.api#required": {} - } - }, - "content": { - "target": "com.amazonaws.bedrockruntime#ContentBlocks", - "traits": { - "smithy.api#documentation": "

The message content. Note the following restrictions:

\n ", - "smithy.api#required": {} - } - } - }, + "com.amazonaws.bedrockruntime#KmsKeyId": { + "type": "string", "traits": { - "smithy.api#documentation": "

A message input, or returned from, a call to Converse or ConverseStream.

" - } + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+))$" + } + }, + "com.amazonaws.bedrockruntime#ListAsyncInvokes": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#ListAsyncInvokesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#ListAsyncInvokesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists asynchronous invocations.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/async-invoke" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "asyncInvokeSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockruntime#ListAsyncInvokesRequest": { + "type": "structure", + "members": { + "submitTimeAfter": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

Include invocations submitted after this time.

", + "smithy.api#httpQuery": "submitTimeAfter" + } + }, + "submitTimeBefore": { + "target": "com.amazonaws.bedrockruntime#Timestamp", + "traits": { + "smithy.api#documentation": "

Include invocations submitted before this time.

", + "smithy.api#httpQuery": "submitTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeStatus", + "traits": { + "smithy.api#documentation": "

Filter invocations by status.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockruntime#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of invocations to return in one page of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockruntime#PaginationToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrockruntime#SortAsyncInvocationBy", + "traits": { + "smithy.api#default": "SubmissionTime", + "smithy.api#documentation": "

How to sort the response.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrockruntime#SortOrder", + "traits": { + "smithy.api#default": "Descending", + "smithy.api#documentation": "

The sorting order for the response.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#ListAsyncInvokesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockruntime#PaginationToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "asyncInvokeSummaries": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeSummaries", + "traits": { + "smithy.api#documentation": "

A list of invocation summaries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockruntime#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockruntime#Message": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockruntime#ConversationRole", + "traits": { + "smithy.api#documentation": "

The role that the message plays in the message.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockruntime#ContentBlocks", + "traits": { + "smithy.api#documentation": "

The message content. Note the following restrictions:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A message input, or returned from, a call to Converse or ConverseStream.

" + } }, "com.amazonaws.bedrockruntime#MessageStartEvent": { "type": "structure", @@ -3453,6 +3943,12 @@ "smithy.api#httpError": 424 } }, + "com.amazonaws.bedrockruntime#ModelInputPayload": { + "type": "document", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockruntime#ModelNotReadyException": { "type": "structure", "members": { @@ -3539,6 +4035,16 @@ } } }, + "com.amazonaws.bedrockruntime#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, "com.amazonaws.bedrockruntime#PartBody": { "type": "blob", "traits": { @@ -3621,6 +4127,36 @@ "smithy.api#documentation": "

Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see How Prompt management works.

" } }, + "com.amazonaws.bedrockruntime#RequestMetadata": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s:_@$#=/+,-.]{1,256}$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s:_@$#=/+,-.]{0,256}$" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockruntime#ResourceNotFoundException": { "type": "structure", "members": { @@ -3685,6 +4221,37 @@ "smithy.api#streaming": {} } }, + "com.amazonaws.bedrockruntime#S3Location": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockruntime#S3Uri", + "traits": { + "smithy.api#documentation": "

An object URI starting with s3://.

", + "smithy.api#required": {} + } + }, + "bucketOwner": { + "target": "com.amazonaws.bedrockruntime#AccountId", + "traits": { + "smithy.api#documentation": "

If the bucket belongs to another AWS account, specify that account's ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A storage location in an S3 bucket.

" + } + }, + "com.amazonaws.bedrockruntime#S3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + } + }, "com.amazonaws.bedrockruntime#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -3711,6 +4278,34 @@ "smithy.api#httpError": 503 } }, + "com.amazonaws.bedrockruntime#SortAsyncInvocationBy": { + "type": "enum", + "members": { + "SUBMISSION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubmissionTime" + } + } + } + }, + "com.amazonaws.bedrockruntime#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, "com.amazonaws.bedrockruntime#SpecificToolChoice": { "type": "structure", "members": { @@ -3726,6 +4321,107 @@ "smithy.api#documentation": "

The model must request a specific tool. For example, {\"tool\" : {\"name\" : \"Your tool name\"}}.

\n \n

This field is only supported by Anthropic Claude 3 models.

\n " } }, + "com.amazonaws.bedrockruntime#StartAsyncInvoke": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#StartAsyncInvokeRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#StartAsyncInvokeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous invocation.

\n

This operation requires permission for the bedrock:InvokeModel action.

\n \n

To deny all inference access to resources that you specify in the modelId field, you\n need to deny access to the bedrock:InvokeModel and\n bedrock:InvokeModelWithResponseStream actions. Doing this also denies\n access to the resource through the Converse API actions (Converse and ConverseStream). For more information see Deny access for inference on specific models.\n

\n ", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/async-invoke" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockruntime#StartAsyncInvokeRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeIdempotencyToken", + "traits": { + "smithy.api#documentation": "

Specify idempotency token to ensure that requests are not duplicated.

", + "smithy.api#idempotencyToken": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeIdentifier", + "traits": { + "smithy.api#documentation": "

The model to invoke.

", + "smithy.api#required": {} + } + }, + "modelInput": { + "target": "com.amazonaws.bedrockruntime#ModelInputPayload", + "traits": { + "smithy.api#documentation": "

Input to send to the model.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrockruntime#AsyncInvokeOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Where to store the output.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockruntime#TagList", + "traits": { + "smithy.api#documentation": "

Tags to apply to the invocation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#StartAsyncInvokeResponse": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockruntime#InvocationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the invocation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockruntime#StatusCode": { "type": "integer", "traits": { @@ -3802,6 +4498,60 @@ "target": "com.amazonaws.bedrockruntime#SystemContentBlock" } }, + "com.amazonaws.bedrockruntime#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockruntime#TagKey", + "traits": { + "smithy.api#documentation": "

The tag's key.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockruntime#TagValue", + "traits": { + "smithy.api#documentation": "

The tag's value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag.

" + } + }, + "com.amazonaws.bedrockruntime#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockruntime#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockruntime#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, "com.amazonaws.bedrockruntime#TextCharactersGuarded": { "type": "integer" }, @@ -3821,6 +4571,12 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.bedrockruntime#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, "com.amazonaws.bedrockruntime#TokenUsage": { "type": "structure", "members": { @@ -3920,7 +4676,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

\n \n

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

\n " + "smithy.api#documentation": "

Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

" } }, "com.amazonaws.bedrockruntime#ToolInputSchema": { @@ -4001,6 +4757,12 @@ "traits": { "smithy.api#documentation": "

A tool result that is a document.

" } + }, + "video": { + "target": "com.amazonaws.bedrockruntime#VideoBlock", + "traits": { + "smithy.api#documentation": "

A tool result that is video.

" + } } }, "traits": { @@ -4169,6 +4931,110 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.bedrockruntime#VideoBlock": { + "type": "structure", + "members": { + "format": { + "target": "com.amazonaws.bedrockruntime#VideoFormat", + "traits": { + "smithy.api#documentation": "

The block's format.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockruntime#VideoSource", + "traits": { + "smithy.api#documentation": "

The block's source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A video block.

" + } + }, + "com.amazonaws.bedrockruntime#VideoFormat": { + "type": "enum", + "members": { + "MKV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mkv" + } + }, + "MOV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mov" + } + }, + "MP4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mp4" + } + }, + "WEBM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "webm" + } + }, + "FLV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "flv" + } + }, + "MPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mpeg" + } + }, + "MPG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mpg" + } + }, + "WMV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "wmv" + } + }, + "THREE_GP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "three_gp" + } + } + } + }, + "com.amazonaws.bedrockruntime#VideoSource": { + "type": "union", + "members": { + "bytes": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "

Video content encoded in base64.

", + "smithy.api#length": { + "min": 1 + } + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockruntime#S3Location", + "traits": { + "smithy.api#documentation": "

The location of a video object in an S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A video source. You can upload a smaller video as a base64-encoded string as\n long as the encoded file is less than 25MB. You can also transfer videos up to 1GB in size\n from an S3 bucket.

" + } } } } \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index 0f64cebdf6c..a1a78a18580 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -1282,7 +1282,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

\n

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter \n out denied topics and words, and remove sensitive information for privacy protection.

\n \n

In addition to the above policies, you can also configure the messages to be returned to \n the user if a user input or model response is in violation of the policies defined in the guardrail.

\n

For more information, see Guardrails for Amazon Bedrock in\n the Amazon Bedrock User Guide.

", + "smithy.api#documentation": "

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

\n

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter \n out denied topics and words, and remove sensitive information for privacy protection.

\n \n

In addition to the above policies, you can also configure the messages to be returned to \n the user if a user input or model response is in violation of the policies defined in the guardrail.

\n

For more information, see Amazon Bedrock Guardrails in\n the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -1824,8 +1824,7 @@ "hyperParameters": { "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", "traits": { - "smithy.api#documentation": "

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

" } }, "vpcConfig": { @@ -1833,6 +1832,12 @@ "traits": { "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see Protect your model customization jobs using a VPC.

" } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "

The customization configuration for the model customization job.

" + } } }, "traits": { @@ -2068,7 +2073,7 @@ "vpcConfig": { "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" + "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" } }, "timeoutDurationInHours": { @@ -2288,6 +2293,20 @@ "target": "com.amazonaws.bedrock#CustomModelSummary" } }, + "com.amazonaws.bedrock#CustomizationConfig": { + "type": "union", + "members": { + "distillationConfig": { + "target": "com.amazonaws.bedrock#DistillationConfig", + "traits": { + "smithy.api#documentation": "

The distillation configuration for the custom model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A model customization configuration

" + } + }, "com.amazonaws.bedrock#CustomizationType": { "type": "enum", "members": { @@ -2302,6 +2321,12 @@ "traits": { "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" } + }, + "DISTILLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTILLATION" + } } } }, @@ -2660,6 +2685,21 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#DistillationConfig": { + "type": "structure", + "members": { + "teacherModelConfig": { + "target": "com.amazonaws.bedrock#TeacherModelConfig", + "traits": { + "smithy.api#documentation": "

The teacher model configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for distilling a foundation model into a smaller and more efficient model.

" + } + }, "com.amazonaws.bedrock#ErrorMessage": { "type": "string", "traits": { @@ -3799,6 +3839,12 @@ "smithy.api#documentation": "

Creation time of the model.

", "smithy.api#required": {} } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "

The customization configuration for the custom model.

" + } } }, "traits": { @@ -4703,8 +4749,7 @@ "hyperParameters": { "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", "traits": { - "smithy.api#documentation": "

The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.

" } }, "trainingDataConfig": { @@ -4757,6 +4802,12 @@ "traits": { "smithy.api#documentation": "

VPC configuration for the custom model job.

" } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "

The customization configuration for the model customization job.

" + } } }, "traits": { @@ -4926,7 +4977,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a batch inference job. For more information, see View details about a batch inference job\n

", + "smithy.api#documentation": "

Gets details about a batch inference job. For more information, see Monitor batch inference jobs\n

", "smithy.api#http": { "code": 200, "method": "GET", @@ -4990,7 +5041,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

" + "smithy.api#documentation": "

The status of the batch inference job.

\n

The following statuses are possible:

\n " } }, "message": { @@ -5035,7 +5086,7 @@ "vpcConfig": { "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" + "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" } }, "timeoutDurationInHours": { @@ -7076,6 +7127,48 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.bedrock#InvocationLogSource": { + "type": "union", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The URI of an invocation log in a bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A storage location for invocation logs.

" + } + }, + "com.amazonaws.bedrock#InvocationLogsConfig": { + "type": "structure", + "members": { + "usePromptResponse": { + "target": "com.amazonaws.bedrock#UsePromptResponse", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to use the model's response for training, or just the prompt. The default value is False.

" + } + }, + "invocationLogSource": { + "target": "com.amazonaws.bedrock#InvocationLogSource", + "traits": { + "smithy.api#documentation": "

The source of the invocation logs.

", + "smithy.api#required": {} + } + }, + "requestMetadataFilters": { + "target": "com.amazonaws.bedrock#RequestMetadataFilters", + "traits": { + "smithy.api#documentation": "

Rules for filtering invocation logs based on request metadata.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for using invocation logs to customize a model.

" + } + }, "com.amazonaws.bedrock#JobName": { "type": "string", "traits": { @@ -8288,7 +8381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

", + "smithy.api#documentation": "

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -8323,7 +8416,7 @@ "statusEquals": { "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", "traits": { - "smithy.api#documentation": "

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

", + "smithy.api#documentation": "

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

\n

The following statuses are possible:

\n ", "smithy.api#httpQuery": "statusEquals" } }, @@ -8620,6 +8713,12 @@ "traits": { "smithy.api#documentation": "

Set to include embeddings data in the log delivery.

" } + }, + "videoDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Set to include video data in the log delivery.

" + } } }, "traits": { @@ -8829,6 +8928,12 @@ "traits": { "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" } + }, + "DISTILLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTILLATION" + } } } }, @@ -9391,7 +9496,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

" + "smithy.api#documentation": "

The status of the batch inference job.

\n

The following statuses are possible:

\n " } }, "message": { @@ -9436,7 +9541,7 @@ "vpcConfig": { "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" + "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" } }, "timeoutDurationInHours": { @@ -9901,6 +10006,100 @@ } } }, + "com.amazonaws.bedrock#RequestMetadataBaseFilters": { + "type": "structure", + "members": { + "equals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "

Include results where the key equals the value.

" + } + }, + "notEquals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "

Include results where the key does not equal the value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A mapping of a metadata key to a value that it should or should not equal.

" + } + }, + "com.amazonaws.bedrock#RequestMetadataFilters": { + "type": "union", + "members": { + "equals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "

Include results where the key equals the value.

" + } + }, + "notEquals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "

Include results where the key does not equal the value.

" + } + }, + "andAll": { + "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "traits": { + "smithy.api#documentation": "

Include results where all of the based filters match.

" + } + }, + "orAll": { + "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "traits": { + "smithy.api#documentation": "

Include results where any of the base filters match.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Rules for filtering invocation logs. A filter can be a mapping of a metadata\n key to a value that it should or should not equal (a base filter), or a list of base filters\n that are all applied with AND or OR logical operators

" + } + }, + "com.amazonaws.bedrock#RequestMetadataFiltersList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RequestMetadataBaseFilters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.bedrock#RequestMetadataMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+$@-]{1,256}$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+$@-]{0,256}$" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrock#ResourceNotFoundException": { "type": "structure", "members": { @@ -10420,7 +10619,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

", + "smithy.api#documentation": "

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -10614,7 +10813,7 @@ "min": 20, "max": 1011 }, - "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model)/[a-z0-9]{12}$)))" + "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke)/[a-z0-9]{12}$)))" } }, "com.amazonaws.bedrock#TaggingResource": { @@ -10631,6 +10830,33 @@ } ] }, + "com.amazonaws.bedrock#TeacherModelConfig": { + "type": "structure", + "members": { + "teacherModelIdentifier": { + "target": "com.amazonaws.bedrock#TeacherModelIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the teacher model.

", + "smithy.api#required": {} + } + }, + "maxResponseLengthForInference": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens requested when the customization job invokes the teacher model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a teacher model used for model customization.

" + } + }, + "com.amazonaws.bedrock#TeacherModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + } + }, "com.amazonaws.bedrock#Temperature": { "type": "float", "traits": { @@ -10735,8 +10961,13 @@ "s3Uri": { "target": "com.amazonaws.bedrock#S3Uri", "traits": { - "smithy.api#documentation": "

The S3 URI where the training data is stored.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The S3 URI where the training data is stored.

" + } + }, + "invocationLogsConfig": { + "target": "com.amazonaws.bedrock#InvocationLogsConfig", + "traits": { + "smithy.api#documentation": "

Settings for using invocation logs to customize a model.

" } } }, @@ -11064,6 +11295,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#UsePromptResponse": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.bedrock#ValidationDataConfig": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/cloudwatch.json b/codegen/sdk-codegen/aws-models/cloudwatch.json index 331f0f1b41d..1ebeb9907ac 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch.json @@ -1818,13 +1818,13 @@ "KeyAttributes": { "target": "com.amazonaws.cloudwatch#EntityKeyAttributesMap", "traits": { - "smithy.api#documentation": "

The attributes of the entity which identify the specific entity, as a list of \n key-value pairs. Entities with the same KeyAttributes are considered to be\n the same entity. For an entity to be valid, the KeyAttributes must exist\n and be formatted correctly.

\n

There are five allowed attributes (key names): Type,\n ResourceType, Identifier, Name, and\n Environment.

\n

For details about how to use the key attributes to specify an entity, see How to add related \n information to telemetry in the CloudWatch User \n Guide.

" + "smithy.api#documentation": "

The attributes of the entity which identify the specific entity, as a list of \n key-value pairs. Entities with the same KeyAttributes are considered to be\n the same entity. For an entity to be valid, the KeyAttributes must exist\n and be formatted correctly.

\n

There are five allowed attributes (key names): Type,\n ResourceType, Identifier, Name, and\n Environment.

\n

For details about how to use the key attributes to specify an entity, see How \n to add related \n information to telemetry in the CloudWatch User \n Guide.

" } }, "Attributes": { "target": "com.amazonaws.cloudwatch#EntityAttributesMap", "traits": { - "smithy.api#documentation": "

Additional attributes of the entity that are not used to specify the identity of the\n entity. A list of key-value pairs.

\n

For details about how to use the attributes, see How to add related information to \n telemetry in the CloudWatch User Guide.

" + "smithy.api#documentation": "

Additional attributes of the entity that are not used to specify the identity of the\n entity. A list of key-value pairs.

\n

For details about how to use the attributes, see How \n to add related information to \n telemetry in the CloudWatch User Guide.

" } } }, @@ -5685,7 +5685,7 @@ "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).

\n

Valid Values: ]

\n

\n Amazon SNS actions:\n

\n

\n arn:aws:sns:region:account-id:sns-topic-name\n \n

\n

\n Lambda actions:\n

\n \n

\n Systems Manager actions:\n

\n

\n arn:aws:ssm:region:account-id:opsitem:severity\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).

\n

Valid Values: ]

\n

\n Amazon SNS actions:\n

\n

\n arn:aws:sns:region:account-id:sns-topic-name\n \n

\n

\n Lambda actions:\n

\n \n

\n Systems Manager actions:\n

\n

\n arn:aws:ssm:region:account-id:opsitem:severity\n \n

\n

\n Start a Amazon Q Developer operational investigation\n

\n

\n arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id\n \n

" } }, "AlarmDescription": { @@ -5974,7 +5974,7 @@ "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:

\n

\n EC2 actions:\n

\n \n

\n Autoscaling action:\n

\n \n

\n Lambda actions:\n

\n \n

\n SNS notification action:\n

\n \n

\n SSM integration actions:\n

\n " + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:

\n

\n EC2 actions:\n

\n \n

\n Autoscaling action:\n

\n \n

\n Lambda actions:\n

\n \n

\n SNS notification action:\n

\n \n

\n SSM integration actions:\n

\n \n

\n Start a Amazon Q Developer operational investigation\n

\n

\n arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id\n \n

" } }, "InsufficientDataActions": { diff --git a/codegen/sdk-codegen/aws-models/datazone.json b/codegen/sdk-codegen/aws-models/datazone.json index 601dac0d441..c7701f0d88f 100644 --- a/codegen/sdk-codegen/aws-models/datazone.json +++ b/codegen/sdk-codegen/aws-models/datazone.json @@ -1595,6 +1595,57 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#AthenaPropertiesInput": { + "type": "structure", + "members": { + "workgroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Athena workgroup name of a connection.

", + "smithy.api#length": { + "max": 64 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Athena properties of a connection.

" + } + }, + "com.amazonaws.datazone#AthenaPropertiesOutput": { + "type": "structure", + "members": { + "workgroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Athena workgroup name of a connection.

", + "smithy.api#length": { + "max": 64 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Athena properties of a connection.

" + } + }, + "com.amazonaws.datazone#AthenaPropertiesPatch": { + "type": "structure", + "members": { + "workgroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Athena workgroup name of a connection.

", + "smithy.api#length": { + "max": 64 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Athena properties patch of a connection.

" + } + }, "com.amazonaws.datazone#Attribute": { "type": "string", "traits": { @@ -1621,6 +1672,150 @@ } } }, + "com.amazonaws.datazone#AuthenticationConfiguration": { + "type": "structure", + "members": { + "authenticationType": { + "target": "com.amazonaws.datazone#AuthenticationType", + "traits": { + "smithy.api#documentation": "

The authentication type of a connection.

" + } + }, + "secretArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The secret ARN of a connection.

", + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$" + } + }, + "oAuth2Properties": { + "target": "com.amazonaws.datazone#OAuth2Properties", + "traits": { + "smithy.api#documentation": "

The oAuth2 properties of a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authentication configuration of a connection.

" + } + }, + "com.amazonaws.datazone#AuthenticationConfigurationInput": { + "type": "structure", + "members": { + "authenticationType": { + "target": "com.amazonaws.datazone#AuthenticationType", + "traits": { + "smithy.api#documentation": "

The authentication type of a connection.

" + } + }, + "oAuth2Properties": { + "target": "com.amazonaws.datazone#OAuth2Properties", + "traits": { + "smithy.api#documentation": "

The oAuth2 properties of a connection.

" + } + }, + "secretArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The secret ARN of a connection.

", + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$" + } + }, + "kmsKeyArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The KMS key ARN of a connection.

", + "smithy.api#pattern": "^$|arn:aws[a-z0-9-]*:kms:.*$" + } + }, + "basicAuthenticationCredentials": { + "target": "com.amazonaws.datazone#BasicAuthenticationCredentials", + "traits": { + "smithy.api#documentation": "

The basic authentication credentials of a connection.

" + } + }, + "customAuthenticationCredentials": { + "target": "com.amazonaws.datazone#CredentialMap", + "traits": { + "smithy.api#documentation": "

The custom authentication credentials of a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authentication configuration of a connection.

" + } + }, + "com.amazonaws.datazone#AuthenticationConfigurationPatch": { + "type": "structure", + "members": { + "secretArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The secret ARN of a connection.

", + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$" + } + }, + "basicAuthenticationCredentials": { + "target": "com.amazonaws.datazone#BasicAuthenticationCredentials", + "traits": { + "smithy.api#documentation": "

The basic authentication credentials of a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authentication configuration patch of a connection.

" + } + }, + "com.amazonaws.datazone#AuthenticationType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.datazone#AuthorizationCodeProperties": { + "type": "structure", + "members": { + "authorizationCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The authorization code of a connection.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "redirectUri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The redirect URI of a connection.

", + "smithy.api#length": { + "max": 512 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The authorization code properties of a connection.

" + } + }, "com.amazonaws.datazone#AuthorizedPrincipalIdentifier": { "type": "string", "traits": { @@ -1639,6 +1834,26 @@ } } }, + "com.amazonaws.datazone#AwsAccount": { + "type": "union", + "members": { + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The account ID of a project.

" + } + }, + "awsAccountIdPath": { + "target": "com.amazonaws.datazone#ParameterStorePath", + "traits": { + "smithy.api#documentation": "

The account ID path of a project.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The account ID of a project.

" + } + }, "com.amazonaws.datazone#AwsAccountId": { "type": "string", "traits": { @@ -1659,12 +1874,74 @@ "smithy.api#documentation": "

The parameters of the console link specified as part of the environment action.

" } }, + "com.amazonaws.datazone#AwsLocation": { + "type": "structure", + "members": { + "accessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The access role of a connection.

", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The account ID of a connection.

" + } + }, + "awsRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "

The Region of a connection.

" + } + }, + "iamConnectionId": { + "target": "com.amazonaws.datazone#ConnectionId", + "traits": { + "smithy.api#documentation": "

The IAM connection ID of a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location of a project.

" + } + }, "com.amazonaws.datazone#AwsRegion": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$" } }, + "com.amazonaws.datazone#BasicAuthenticationCredentials": { + "type": "structure", + "members": { + "userName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The user name for the connecion.

", + "smithy.api#length": { + "max": 512 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "password": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The password for a connection.

", + "smithy.api#length": { + "max": 512 + }, + "smithy.api#pattern": "^.*$" + } + } + }, + "traits": { + "smithy.api#documentation": "

The basic authentication credentials of a connection.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.datazone#BusinessNameGenerationConfiguration": { "type": "structure", "members": { @@ -1953,6 +2230,41 @@ "target": "smithy.api#String" } }, + "com.amazonaws.datazone#ComputeEnvironments": { + "type": "enum", + "members": { + "SPARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPARK" + } + }, + "ATHENA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATHENA" + } + }, + "PYTHON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON" + } + } + } + }, + "com.amazonaws.datazone#ComputeEnvironmentsList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ComputeEnvironments" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.datazone#ConfigurableActionParameter": { "type": "structure", "members": { @@ -2040,437 +2352,503 @@ "smithy.api#httpError": 409 } }, - "com.amazonaws.datazone#CreateAsset": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#CreateAssetInput" - }, - "output": { - "target": "com.amazonaws.datazone#CreateAssetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.datazone#AccessDeniedException" - }, - { - "target": "com.amazonaws.datazone#ConflictException" - }, - { - "target": "com.amazonaws.datazone#InternalServerException" - }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" + "com.amazonaws.datazone#ConnectionCredentials": { + "type": "structure", + "members": { + "accessKeyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The access key ID of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + "secretAccessKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The secret access key of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#ThrottlingException" + "sessionToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The session token of a connection credentials.

" + } }, - { - "target": "com.amazonaws.datazone#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an asset in Amazon DataZone catalog.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/assets" - }, - "smithy.api#idempotent": {} + "expiration": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The expiration of the connection credentials.

", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "

The credentials of a connection.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#CreateAssetFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#CreateAssetFilterInput" - }, - "output": { - "target": "com.amazonaws.datazone#CreateAssetFilterOutput" + "com.amazonaws.datazone#ConnectionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + } + } + }, + "com.amazonaws.datazone#ConnectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + } + } + }, + "com.amazonaws.datazone#ConnectionProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" }, - "errors": [ - { - "target": "com.amazonaws.datazone#AccessDeniedException" + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + } + }, + "com.amazonaws.datazone#ConnectionPropertiesInput": { + "type": "union", + "members": { + "athenaProperties": { + "target": "com.amazonaws.datazone#AthenaPropertiesInput", + "traits": { + "smithy.api#documentation": "

The Amazon Athena properties of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#ConflictException" + "glueProperties": { + "target": "com.amazonaws.datazone#GluePropertiesInput", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue properties of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#InternalServerException" + "hyperPodProperties": { + "target": "com.amazonaws.datazone#HyperPodPropertiesInput", + "traits": { + "smithy.api#documentation": "

The hyper pod properties of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" + "iamProperties": { + "target": "com.amazonaws.datazone#IamPropertiesInput", + "traits": { + "smithy.api#documentation": "

The IAM properties of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + "redshiftProperties": { + "target": "com.amazonaws.datazone#RedshiftPropertiesInput", + "traits": { + "smithy.api#documentation": "

The Amazon Redshift properties of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#ThrottlingException" + "sparkEmrProperties": { + "target": "com.amazonaws.datazone#SparkEmrPropertiesInput", + "traits": { + "smithy.api#documentation": "

The Spark EMR properties of a connection.

" + } }, - { - "target": "com.amazonaws.datazone#ValidationException" + "sparkGlueProperties": { + "target": "com.amazonaws.datazone#SparkGluePropertiesInput", + "traits": { + "smithy.api#documentation": "

The Spark Amazon Web Services Glue properties of a connection.

" + } } - ], + }, "traits": { - "smithy.api#documentation": "

Creates a data asset filter.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "

The properties of a connection.

" } }, - "com.amazonaws.datazone#CreateAssetFilterInput": { - "type": "structure", + "com.amazonaws.datazone#ConnectionPropertiesOutput": { + "type": "union", "members": { - "domainIdentifier": { - "target": "com.amazonaws.datazone#DomainId", + "athenaProperties": { + "target": "com.amazonaws.datazone#AthenaPropertiesOutput", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Athena properties of a connection.

" } }, - "assetIdentifier": { - "target": "com.amazonaws.datazone#AssetId", + "glueProperties": { + "target": "com.amazonaws.datazone#GluePropertiesOutput", "traits": { - "smithy.api#documentation": "

The ID of the data asset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Web Services Glue properties of a connection.

" } }, - "name": { - "target": "com.amazonaws.datazone#FilterName", + "hyperPodProperties": { + "target": "com.amazonaws.datazone#HyperPodPropertiesOutput", "traits": { - "smithy.api#documentation": "

The name of the asset filter.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The hyper pod properties of a connection.

" } }, - "description": { - "target": "com.amazonaws.datazone#Description", + "iamProperties": { + "target": "com.amazonaws.datazone#IamPropertiesOutput", "traits": { - "smithy.api#documentation": "

The description of the asset filter.

" + "smithy.api#documentation": "

The IAM properties of a connection.

" } }, - "configuration": { - "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "redshiftProperties": { + "target": "com.amazonaws.datazone#RedshiftPropertiesOutput", "traits": { - "smithy.api#documentation": "

The configuration of the asset filter.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Redshift properties of a connection.

" } }, - "clientToken": { - "target": "smithy.api#String", + "sparkEmrProperties": { + "target": "com.amazonaws.datazone#SparkEmrPropertiesOutput", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The Spark EMR properties of a connection.

" + } + }, + "sparkGlueProperties": { + "target": "com.amazonaws.datazone#SparkGluePropertiesOutput", + "traits": { + "smithy.api#documentation": "

The Spark Amazon Web Services Glue properties of a connection.

" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

The properties of a connection.

" } }, - "com.amazonaws.datazone#CreateAssetFilterOutput": { - "type": "structure", + "com.amazonaws.datazone#ConnectionPropertiesPatch": { + "type": "union", "members": { - "id": { - "target": "com.amazonaws.datazone#FilterId", + "athenaProperties": { + "target": "com.amazonaws.datazone#AthenaPropertiesPatch", "traits": { - "smithy.api#documentation": "

The ID of the asset filter.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Athena properties of a connection properties patch.

" } }, - "domainId": { - "target": "com.amazonaws.datazone#DomainId", + "glueProperties": { + "target": "com.amazonaws.datazone#GluePropertiesPatch", "traits": { - "smithy.api#documentation": "

The ID of the domain where the asset filter is created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Web Services Glue properties of a connection properties patch.

" } }, - "assetId": { - "target": "com.amazonaws.datazone#AssetId", + "iamProperties": { + "target": "com.amazonaws.datazone#IamPropertiesPatch", "traits": { - "smithy.api#documentation": "

The ID of the asset.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IAM properties of a connection properties patch.

" } }, - "name": { - "target": "com.amazonaws.datazone#FilterName", + "redshiftProperties": { + "target": "com.amazonaws.datazone#RedshiftPropertiesPatch", "traits": { - "smithy.api#documentation": "

The name of the asset filter.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Redshift properties of a connection properties patch.

" } }, - "description": { - "target": "com.amazonaws.datazone#Description", + "sparkEmrProperties": { + "target": "com.amazonaws.datazone#SparkEmrPropertiesPatch", "traits": { - "smithy.api#documentation": "

The description of the asset filter.

" + "smithy.api#documentation": "

The Spark EMR properties of a connection properties patch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The connection properties patch.

" + } + }, + "com.amazonaws.datazone#ConnectionStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" } }, - "status": { - "target": "com.amazonaws.datazone#FilterStatus", + "CREATE_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The status of the asset filter.

" + "smithy.api#enumValue": "CREATE_FAILED" } }, - "configuration": { - "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "DELETING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The configuration of the asset filter.

", - "smithy.api#required": {} + "smithy.api#enumValue": "DELETING" } }, - "createdAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "DELETE_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" + "smithy.api#enumValue": "DELETE_FAILED" } }, - "errorMessage": { - "target": "smithy.api#String", + "READY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The error message that is displayed if the asset filter is not created\n successfully.

" + "smithy.api#enumValue": "READY" } }, - "effectiveColumnNames": { - "target": "com.amazonaws.datazone#ColumnNameList", + "UPDATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The column names in the asset filter.

" + "smithy.api#enumValue": "UPDATING" } }, - "effectiveRowFilter": { - "target": "smithy.api#String", + "UPDATE_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The row filter in the asset filter.

" + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" } } - }, - "traits": { - "smithy.api#output": {} } }, - "com.amazonaws.datazone#CreateAssetInput": { + "com.amazonaws.datazone#ConnectionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ConnectionSummary" + } + }, + "com.amazonaws.datazone#ConnectionSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.datazone#AssetName", + "connectionId": { + "target": "com.amazonaws.datazone#ConnectionId", "traits": { - "smithy.api#documentation": "

Asset name.

", + "smithy.api#documentation": "

The ID of a connection.

", "smithy.api#required": {} } }, - "domainIdentifier": { + "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

Amazon DataZone domain where the asset is created.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The domain ID of a connection.

", "smithy.api#required": {} } }, - "externalIdentifier": { - "target": "com.amazonaws.datazone#ExternalIdentifier", - "traits": { - "smithy.api#documentation": "

The external identifier of the asset.

" - } - }, - "typeIdentifier": { - "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "

The unique identifier of this asset's type.

", + "smithy.api#documentation": "

The domain unit ID of a connection.

", "smithy.api#required": {} } }, - "typeRevision": { - "target": "com.amazonaws.datazone#Revision", - "traits": { - "smithy.api#documentation": "

The revision of this asset's type.

" - } - }, - "description": { - "target": "com.amazonaws.datazone#Description", + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

Asset description.

" + "smithy.api#documentation": "

The environment ID of a connection.

" } }, - "glossaryTerms": { - "target": "com.amazonaws.datazone#GlossaryTerms", + "name": { + "target": "com.amazonaws.datazone#ConnectionName", "traits": { - "smithy.api#documentation": "

Glossary terms attached to the asset.

" + "smithy.api#documentation": "

The connection name.

", + "smithy.api#required": {} } }, - "formsInput": { - "target": "com.amazonaws.datazone#FormInputList", + "physicalEndpoints": { + "target": "com.amazonaws.datazone#PhysicalEndpoints", "traits": { - "smithy.api#documentation": "

Metadata forms attached to the asset.

" + "smithy.api#documentation": "

The connection physical endpoints.

", + "smithy.api#required": {} } }, - "owningProjectIdentifier": { + "projectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The unique identifier of the project that owns this asset.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The connection project ID.

" } }, - "predictionConfiguration": { - "target": "com.amazonaws.datazone#PredictionConfiguration", + "props": { + "target": "com.amazonaws.datazone#ConnectionPropertiesOutput", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#notProperty": {} + "smithy.api#documentation": "

The connection props.

" } }, - "clientToken": { - "target": "com.amazonaws.datazone#ClientToken", + "type": { + "target": "com.amazonaws.datazone#ConnectionType", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The connection type.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

The summary of a connection.

" } }, - "com.amazonaws.datazone#CreateAssetOutput": { - "type": "structure", + "com.amazonaws.datazone#ConnectionType": { + "type": "enum", "members": { - "id": { - "target": "com.amazonaws.datazone#AssetId", + "ATHENA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The unique identifier of the created asset.

", - "smithy.api#required": {} + "smithy.api#enumValue": "ATHENA" } }, - "name": { - "target": "com.amazonaws.datazone#AssetName", + "BIGQUERY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name of the created asset.

", - "smithy.api#required": {} + "smithy.api#enumValue": "BIGQUERY" } }, - "typeIdentifier": { - "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "DATABRICKS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The identifier of the created asset type.

", - "smithy.api#required": {} + "smithy.api#enumValue": "DATABRICKS" } }, - "typeRevision": { - "target": "com.amazonaws.datazone#Revision", + "DOCUMENTDB": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The revision type of the asset.

", - "smithy.api#required": {} + "smithy.api#enumValue": "DOCUMENTDB" } }, - "externalIdentifier": { - "target": "com.amazonaws.datazone#ExternalIdentifier", + "DYNAMODB": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The external identifier of the asset.

" + "smithy.api#enumValue": "DYNAMODB" } }, - "revision": { - "target": "com.amazonaws.datazone#Revision", + "HYPERPOD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The revision of the asset.

", - "smithy.api#required": {} + "smithy.api#enumValue": "HYPERPOD" } }, - "description": { - "target": "com.amazonaws.datazone#Description", + "IAM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The description of the created asset.

" + "smithy.api#enumValue": "IAM" } }, - "createdAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "MYSQL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The timestamp of when the asset was created.

" + "smithy.api#enumValue": "MYSQL" } }, - "createdBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "OPENSEARCH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon DataZone user that created this asset in the catalog.

" + "smithy.api#enumValue": "OPENSEARCH" } }, - "firstRevisionCreatedAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "ORACLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The timestamp of when the first revision of the asset took place.

" + "smithy.api#enumValue": "ORACLE" } }, - "firstRevisionCreatedBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "POSTGRESQL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon DataZone user that made the first revision of the asset.

" + "smithy.api#enumValue": "POSTGRESQL" } }, - "glossaryTerms": { - "target": "com.amazonaws.datazone#GlossaryTerms", + "REDSHIFT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The glossary terms that are attached to the created asset.

" + "smithy.api#enumValue": "REDSHIFT" } }, - "owningProjectId": { - "target": "com.amazonaws.datazone#ProjectId", + "SAPHANA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone project that owns the created asset.

", - "smithy.api#required": {} + "smithy.api#enumValue": "SAPHANA" } }, - "domainId": { - "target": "com.amazonaws.datazone#DomainId", + "SNOWFLAKE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the asset was created.

", - "smithy.api#required": {} + "smithy.api#enumValue": "SNOWFLAKE" } }, - "listing": { - "target": "com.amazonaws.datazone#AssetListingDetails", + "SPARK": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The details of an asset published in an Amazon DataZone catalog.

" + "smithy.api#enumValue": "SPARK" } }, - "formsOutput": { - "target": "com.amazonaws.datazone#FormOutputList", + "SQLSERVER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The metadata forms that are attached to the created asset.

", - "smithy.api#required": {} + "smithy.api#enumValue": "SQLSERVER" } }, - "readOnlyFormsOutput": { - "target": "com.amazonaws.datazone#FormOutputList", + "TERADATA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The read-only metadata forms that are attached to the created asset.

" + "smithy.api#enumValue": "TERADATA" } }, - "latestTimeSeriesDataPointFormsOutput": { - "target": "com.amazonaws.datazone#TimeSeriesDataPointSummaryFormOutputList", + "VERTICA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The latest data point that was imported into the time series form for the asset.

" + "smithy.api#enumValue": "VERTICA" } }, - "predictionConfiguration": { - "target": "com.amazonaws.datazone#PredictionConfiguration", + "WORKFLOWS_MWAA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#notProperty": {} + "smithy.api#enumValue": "WORKFLOWS_MWAA" } } + } + }, + "com.amazonaws.datazone#CreateAsset": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateAssetInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateAssetOutput" }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Creates an asset in Amazon DataZone catalog.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/assets" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.datazone#CreateAssetRevision": { + "com.amazonaws.datazone#CreateAssetFilter": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#CreateAssetRevisionInput" + "target": "com.amazonaws.datazone#CreateAssetFilterInput" }, "output": { - "target": "com.amazonaws.datazone#CreateAssetRevisionOutput" + "target": "com.amazonaws.datazone#CreateAssetFilterOutput" }, "errors": [ { @@ -2485,6 +2863,9 @@ { "target": "com.amazonaws.datazone#ResourceNotFoundException" }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -2493,74 +2874,56 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a revision of the asset.

", + "smithy.api#documentation": "

Creates a data asset filter.

", "smithy.api#http": { - "code": 200, + "code": 201, "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}/revisions" + "uri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.datazone#CreateAssetRevisionInput": { + "com.amazonaws.datazone#CreateAssetFilterInput": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.datazone#AssetName", - "traits": { - "smithy.api#documentation": "

Te revised name of the asset.

", - "smithy.api#required": {} - } - }, "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "identifier": { - "target": "com.amazonaws.datazone#AssetIdentifier", + "assetIdentifier": { + "target": "com.amazonaws.datazone#AssetId", "traits": { - "smithy.api#documentation": "

The identifier of the asset.

", + "smithy.api#documentation": "

The ID of the data asset.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "typeRevision": { - "target": "com.amazonaws.datazone#Revision", + "name": { + "target": "com.amazonaws.datazone#FilterName", "traits": { - "smithy.api#documentation": "

The revision type of the asset.

" + "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The revised description of the asset.

" - } - }, - "glossaryTerms": { - "target": "com.amazonaws.datazone#GlossaryTerms", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "formsInput": { - "target": "com.amazonaws.datazone#FormInputList", - "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The description of the asset filter.

" } }, - "predictionConfiguration": { - "target": "com.amazonaws.datazone#PredictionConfiguration", + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#notProperty": {} + "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#required": {} } }, "clientToken": { - "target": "com.amazonaws.datazone#ClientToken", + "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {} @@ -2571,117 +2934,277 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#CreateAssetRevisionOutput": { + "com.amazonaws.datazone#CreateAssetFilterOutput": { "type": "structure", "members": { "id": { - "target": "com.amazonaws.datazone#AssetId", + "target": "com.amazonaws.datazone#FilterId", "traits": { - "smithy.api#documentation": "

The unique identifier of the asset revision.

", + "smithy.api#documentation": "

The ID of the asset filter.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.datazone#AssetName", + "domainId": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The revised name of the asset.

", + "smithy.api#documentation": "

The ID of the domain where the asset filter is created.

", "smithy.api#required": {} } }, - "typeIdentifier": { - "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "assetId": { + "target": "com.amazonaws.datazone#AssetId", "traits": { - "smithy.api#documentation": "

The identifier of the revision type.

", + "smithy.api#documentation": "

The ID of the asset.

", "smithy.api#required": {} } }, - "typeRevision": { - "target": "com.amazonaws.datazone#Revision", + "name": { + "target": "com.amazonaws.datazone#FilterName", "traits": { - "smithy.api#documentation": "

The revision type of the asset.

", + "smithy.api#documentation": "

The name of the asset filter.

", "smithy.api#required": {} } }, - "externalIdentifier": { - "target": "com.amazonaws.datazone#ExternalIdentifier", + "description": { + "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The external identifier of the asset.

" + "smithy.api#documentation": "

The description of the asset filter.

" } }, - "revision": { - "target": "com.amazonaws.datazone#Revision", + "status": { + "target": "com.amazonaws.datazone#FilterStatus", "traits": { - "smithy.api#documentation": "

The revision of the asset.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The status of the asset filter.

" } }, - "description": { - "target": "com.amazonaws.datazone#Description", + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", "traits": { - "smithy.api#documentation": "

The revised asset description.

" + "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "

The timestamp of when the asset revision occured.

" + "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" } }, - "createdBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "errorMessage": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon DataZone user who performed the asset revision.

" + "smithy.api#documentation": "

The error message that is displayed if the asset filter is not created\n successfully.

" } }, - "firstRevisionCreatedAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "effectiveColumnNames": { + "target": "com.amazonaws.datazone#ColumnNameList", "traits": { - "smithy.api#documentation": "

The timestamp of when the first asset revision occured.

" + "smithy.api#documentation": "

The column names in the asset filter.

" } }, - "firstRevisionCreatedBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "effectiveRowFilter": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon DataZone user who performed the first asset revision.

" + "smithy.api#documentation": "

The row filter in the asset filter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateAssetInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "

Asset name.

", + "smithy.api#required": {} + } + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

Amazon DataZone domain where the asset is created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "

The external identifier of the asset.

" + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of this asset's type.

", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision of this asset's type.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

Asset description.

" } }, "glossaryTerms": { "target": "com.amazonaws.datazone#GlossaryTerms", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

Glossary terms attached to the asset.

" + } + }, + "formsInput": { + "target": "com.amazonaws.datazone#FormInputList", + "traits": { + "smithy.api#documentation": "

Metadata forms attached to the asset.

" + } + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the project that owns this asset.

", + "smithy.api#required": {} + } + }, + "predictionConfiguration": { + "target": "com.amazonaws.datazone#PredictionConfiguration", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#notProperty": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateAssetOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the created asset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "

The name of the created asset.

", + "smithy.api#required": {} + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the created asset type.

", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision type of the asset.

", + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "

The external identifier of the asset.

" + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision of the asset.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the created asset.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp of when the asset was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon DataZone user that created this asset in the catalog.

" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp of when the first revision of the asset took place.

" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon DataZone user that made the first revision of the asset.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms that are attached to the created asset.

" } }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The unique identifier of the revised project that owns the asset.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone project that owns the created asset.

", "smithy.api#required": {} } }, "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the asset was revised.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the asset was created.

", "smithy.api#required": {} } }, "listing": { "target": "com.amazonaws.datazone#AssetListingDetails", "traits": { - "smithy.api#documentation": "

The details of an asset published in an Amazon DataZone catalog.

" + "smithy.api#documentation": "

The details of an asset published in an Amazon DataZone catalog.

" } }, "formsOutput": { "target": "com.amazonaws.datazone#FormOutputList", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The metadata forms that are attached to the created asset.

", "smithy.api#required": {} } }, "readOnlyFormsOutput": { "target": "com.amazonaws.datazone#FormOutputList", "traits": { - "smithy.api#documentation": "

The read-only metadata forms that were attached to the asset as part of the asset\n revision.

" + "smithy.api#documentation": "

The read-only metadata forms that are attached to the created asset.

" } }, "latestTimeSeriesDataPointFormsOutput": { @@ -2702,13 +3225,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#CreateAssetType": { + "com.amazonaws.datazone#CreateAssetRevision": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#CreateAssetTypeInput" + "target": "com.amazonaws.datazone#CreateAssetRevisionInput" }, "output": { - "target": "com.amazonaws.datazone#CreateAssetTypeOutput" + "target": "com.amazonaws.datazone#CreateAssetRevisionOutput" }, "errors": [ { @@ -2721,7 +3244,7 @@ "target": "com.amazonaws.datazone#InternalServerException" }, { - "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + "target": "com.amazonaws.datazone#ResourceNotFoundException" }, { "target": "com.amazonaws.datazone#ThrottlingException" @@ -2731,53 +3254,77 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a custom asset type.

", + "smithy.api#documentation": "

Creates a revision of the asset.

", "smithy.api#http": { - "code": 201, + "code": 200, "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/asset-types" - } + "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}/revisions" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.datazone#CreateAssetTypeInput": { + "com.amazonaws.datazone#CreateAssetRevisionInput": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "

Te revised name of the asset.

", + "smithy.api#required": {} + } + }, "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the custom asset type is being\n created.

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.datazone#TypeName", + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", "traits": { - "smithy.api#documentation": "

The name of the custom asset type.

", + "smithy.api#documentation": "

The identifier of the asset.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision type of the asset.

" + } + }, "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The descripton of the custom asset type.

" + "smithy.api#documentation": "

The revised description of the asset.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

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

" } }, "formsInput": { - "target": "com.amazonaws.datazone#FormsInputMap", + "target": "com.amazonaws.datazone#FormInputList", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} + "smithy.api#documentation": "

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

" } }, - "owningProjectIdentifier": { - "target": "com.amazonaws.datazone#ProjectId", + "predictionConfiguration": { + "target": "com.amazonaws.datazone#PredictionConfiguration", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#property": { - "name": "owningProjectId" - }, - "smithy.api#required": {} + "smithy.api#documentation": "

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

", + "smithy.api#notProperty": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#idempotencyToken": {} } } }, @@ -2785,83 +3332,130 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#CreateAssetTypeOutput": { + "com.amazonaws.datazone#CreateAssetRevisionOutput": { "type": "structure", "members": { - "domainId": { - "target": "com.amazonaws.datazone#DomainId", + "id": { + "target": "com.amazonaws.datazone#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the asset type was created.

", + "smithy.api#documentation": "

The unique identifier of the asset revision.

", "smithy.api#required": {} } }, "name": { - "target": "com.amazonaws.datazone#TypeName", + "target": "com.amazonaws.datazone#AssetName", "traits": { - "smithy.api#documentation": "

The name of the asset type.

", + "smithy.api#documentation": "

The revised name of the asset.

", "smithy.api#required": {} } }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the revision type.

", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision type of the asset.

", + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "

The external identifier of the asset.

" + } + }, "revision": { "target": "com.amazonaws.datazone#Revision", "traits": { - "smithy.api#documentation": "

The revision of the custom asset type.

", + "smithy.api#documentation": "

The revision of the asset.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The description of the custom asset type.

" + "smithy.api#documentation": "

The revised asset description.

" } }, - "formsOutput": { - "target": "com.amazonaws.datazone#FormsOutputMap", + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "

The metadata forms that are attached to the asset type.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The timestamp of when the asset revision occured.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon DataZone user who performed the asset revision.

" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp of when the first asset revision occured.

" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon DataZone user who performed the first asset revision.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

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

" } }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone project that currently owns this asset type.

" + "smithy.api#documentation": "

The unique identifier of the revised project that owns the asset.

", + "smithy.api#required": {} } }, - "originDomainId": { + "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain where the asset type was originally created.

" + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the asset was revised.

", + "smithy.api#required": {} } }, - "originProjectId": { - "target": "com.amazonaws.datazone#ProjectId", + "listing": { + "target": "com.amazonaws.datazone#AssetListingDetails", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone project where the asset type was originally created.

" + "smithy.api#documentation": "

The details of an asset published in an Amazon DataZone catalog.

" } }, - "createdAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", "traits": { - "smithy.api#documentation": "

The timestamp of when the asset type is to be created.

" + "smithy.api#documentation": "

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

", + "smithy.api#required": {} } }, - "createdBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "readOnlyFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", "traits": { - "smithy.api#documentation": "

The Amazon DataZone user who creates this custom asset type.

" + "smithy.api#documentation": "

The read-only metadata forms that were attached to the asset as part of the asset\n revision.

" } }, - "updatedAt": { - "target": "com.amazonaws.datazone#UpdatedAt", + "latestTimeSeriesDataPointFormsOutput": { + "target": "com.amazonaws.datazone#TimeSeriesDataPointSummaryFormOutputList", "traits": { - "smithy.api#documentation": "

The timestamp of when the custom type was created.

" + "smithy.api#documentation": "

The latest data point that was imported into the time series form for the asset.

" } }, - "updatedBy": { - "target": "com.amazonaws.datazone#UpdatedBy", + "predictionConfiguration": { + "target": "com.amazonaws.datazone#PredictionConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon DataZone user that created the custom asset type.

" + "smithy.api#documentation": "

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

", + "smithy.api#notProperty": {} } } }, @@ -2869,27 +3463,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#CreateAssetTypePolicyGrantDetail": { - "type": "structure", - "members": { - "includeChildDomainUnits": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details of the policy grant.

" - } - }, - "com.amazonaws.datazone#CreateDataProduct": { + "com.amazonaws.datazone#CreateAssetType": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#CreateDataProductInput" + "target": "com.amazonaws.datazone#CreateAssetTypeInput" }, "output": { - "target": "com.amazonaws.datazone#CreateDataProductOutput" + "target": "com.amazonaws.datazone#CreateAssetTypeOutput" }, "errors": [ { @@ -2901,9 +3481,6 @@ { "target": "com.amazonaws.datazone#InternalServerException" }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" - }, { "target": "com.amazonaws.datazone#ServiceQuotaExceededException" }, @@ -2915,69 +3492,53 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data product.

", + "smithy.api#documentation": "

Creates a custom asset type.

", "smithy.api#http": { "code": 201, "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/data-products" - }, - "smithy.api#idempotent": {} + "uri": "/v2/domains/{domainIdentifier}/asset-types" + } } }, - "com.amazonaws.datazone#CreateDataProductInput": { + "com.amazonaws.datazone#CreateAssetTypeInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain where the data product is created.

", + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the custom asset type is being\n created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { - "target": "com.amazonaws.datazone#DataProductName", - "traits": { - "smithy.api#documentation": "

The name of the data product.

", - "smithy.api#required": {} - } - }, - "owningProjectIdentifier": { - "target": "com.amazonaws.datazone#ProjectId", + "target": "com.amazonaws.datazone#TypeName", "traits": { - "smithy.api#documentation": "

The ID of the owning project of the data product.

", + "smithy.api#documentation": "

The name of the custom asset type.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.datazone#DataProductDescription", - "traits": { - "smithy.api#documentation": "

The description of the data product.

" - } - }, - "glossaryTerms": { - "target": "com.amazonaws.datazone#GlossaryTerms", + "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The glossary terms of the data product.

" + "smithy.api#documentation": "

The descripton of the custom asset type.

" } }, "formsInput": { - "target": "com.amazonaws.datazone#FormInputList", - "traits": { - "smithy.api#documentation": "

The metadata forms of the data product.

" - } - }, - "items": { - "target": "com.amazonaws.datazone#DataProductItems", + "target": "com.amazonaws.datazone#FormsInputMap", "traits": { - "smithy.api#documentation": "

The data assets of the data product.

" + "smithy.api#documentation": "

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

", + "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.datazone#ClientToken", + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

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

", + "smithy.api#property": { + "name": "owningProjectId" + }, + "smithy.api#required": {} } } }, @@ -2985,98 +3546,83 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#CreateDataProductOutput": { + "com.amazonaws.datazone#CreateAssetTypeOutput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain where the data product lives.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the asset type was created.

", "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.datazone#DataProductId", + "name": { + "target": "com.amazonaws.datazone#TypeName", "traits": { - "smithy.api#documentation": "

The ID of the data product.

", + "smithy.api#documentation": "

The name of the asset type.

", "smithy.api#required": {} } }, "revision": { "target": "com.amazonaws.datazone#Revision", "traits": { - "smithy.api#documentation": "

The revision of the data product.

", - "smithy.api#required": {} - } - }, - "owningProjectId": { - "target": "com.amazonaws.datazone#ProjectId", - "traits": { - "smithy.api#documentation": "

The ID of the owning project of the data product.

", + "smithy.api#documentation": "

The revision of the custom asset type.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.datazone#DataProductName", + "description": { + "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The name of the data product.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the custom asset type.

" } }, - "status": { - "target": "com.amazonaws.datazone#DataProductStatus", + "formsOutput": { + "target": "com.amazonaws.datazone#FormsOutputMap", "traits": { - "smithy.api#default": "CREATED", - "smithy.api#documentation": "

The status of the data product.

", + "smithy.api#documentation": "

The metadata forms that are attached to the asset type.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.datazone#DataProductDescription", - "traits": { - "smithy.api#documentation": "

The description of the data product.

" - } - }, - "glossaryTerms": { - "target": "com.amazonaws.datazone#GlossaryTerms", + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The glossary terms of the data product.

" + "smithy.api#documentation": "

The ID of the Amazon DataZone project that currently owns this asset type.

" } }, - "items": { - "target": "com.amazonaws.datazone#DataProductItems", + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The data assets of the data product.

" + "smithy.api#documentation": "

The ID of the Amazon DataZone domain where the asset type was originally created.

" } }, - "formsOutput": { - "target": "com.amazonaws.datazone#FormOutputList", + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The metadata forms of the data product.

" + "smithy.api#documentation": "

The ID of the Amazon DataZone project where the asset type was originally created.

" } }, "createdAt": { "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "

The timestamp at which the data product was created.

" + "smithy.api#documentation": "

The timestamp of when the asset type is to be created.

" } }, "createdBy": { "target": "com.amazonaws.datazone#CreatedBy", "traits": { - "smithy.api#documentation": "

The user who created the data product.

" + "smithy.api#documentation": "

The Amazon DataZone user who creates this custom asset type.

" } }, - "firstRevisionCreatedAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", "traits": { - "smithy.api#documentation": "

The timestamp at which the first revision of the data product was created.

" + "smithy.api#documentation": "

The timestamp of when the custom type was created.

" } }, - "firstRevisionCreatedBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", "traits": { - "smithy.api#documentation": "

The user who created the first revision of the data product.

" + "smithy.api#documentation": "

The Amazon DataZone user that created the custom asset type.

" } } }, @@ -3084,17 +3630,31 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#CreateDataProductRevision": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#CreateDataProductRevisionInput" - }, - "output": { - "target": "com.amazonaws.datazone#CreateDataProductRevisionOutput" - }, - "errors": [ - { - "target": "com.amazonaws.datazone#AccessDeniedException" + "com.amazonaws.datazone#CreateAssetTypePolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the policy grant.

" + } + }, + "com.amazonaws.datazone#CreateConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateConnectionInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateConnectionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" }, { "target": "com.amazonaws.datazone#ConflictException" @@ -3105,6 +3665,9 @@ { "target": "com.amazonaws.datazone#ResourceNotFoundException" }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -3113,30 +3676,195 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data product revision.

", + "smithy.api#documentation": "

Creates a new connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 201, "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}/revisions" + "uri": "/v2/domains/{domainIdentifier}/connections" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.datazone#CreateDataProductRevisionInput": { + "com.amazonaws.datazone#CreateConnectionInput": { "type": "structure", "members": { + "awsLocation": { + "target": "com.amazonaws.datazone#AwsLocation", + "traits": { + "smithy.api#documentation": "

The location where the connection is created.

" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

A connection description.

", + "smithy.api#length": { + "max": 128 + } + } + }, "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The ID of the domain where the connection is created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "identifier": { - "target": "com.amazonaws.datazone#DataProductId", + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The ID of the data product revision.

", + "smithy.api#documentation": "

The ID of the environment where the connection is created.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ConnectionName", + "traits": { + "smithy.api#documentation": "

The connection name.

", + "smithy.api#required": {} + } + }, + "props": { + "target": "com.amazonaws.datazone#ConnectionPropertiesInput", + "traits": { + "smithy.api#documentation": "

The connection props.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateConnectionOutput": { + "type": "structure", + "members": { + "connectionId": { + "target": "com.amazonaws.datazone#ConnectionId", + "traits": { + "smithy.api#documentation": "

The ID of the connection.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The connection description.

" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the connection is created.

", + "smithy.api#required": {} + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit where the connection is created.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "

The ID of the environment where the connection is created.

" + } + }, + "name": { + "target": "com.amazonaws.datazone#ConnectionName", + "traits": { + "smithy.api#documentation": "

The connection name.

", + "smithy.api#required": {} + } + }, + "physicalEndpoints": { + "target": "com.amazonaws.datazone#PhysicalEndpoints", + "traits": { + "smithy.api#documentation": "

The physical endpoints of the connection.

", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the project where the connection is created.

" + } + }, + "props": { + "target": "com.amazonaws.datazone#ConnectionPropertiesOutput", + "traits": { + "smithy.api#documentation": "

The connection props.

" + } + }, + "type": { + "target": "com.amazonaws.datazone#ConnectionType", + "traits": { + "smithy.api#documentation": "

The connection type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateDataProduct": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateDataProductInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateDataProductOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data product.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/data-products" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateDataProductInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the data product is created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3144,32 +3872,39 @@ "name": { "target": "com.amazonaws.datazone#DataProductName", "traits": { - "smithy.api#documentation": "

The name of the data product revision.

", + "smithy.api#documentation": "

The name of the data product.

", + "smithy.api#required": {} + } + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the owning project of the data product.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.datazone#DataProductDescription", "traits": { - "smithy.api#documentation": "

The description of the data product revision.

" + "smithy.api#documentation": "

The description of the data product.

" } }, "glossaryTerms": { "target": "com.amazonaws.datazone#GlossaryTerms", "traits": { - "smithy.api#documentation": "

The glossary terms of the data product revision.

" + "smithy.api#documentation": "

The glossary terms of the data product.

" } }, - "items": { - "target": "com.amazonaws.datazone#DataProductItems", + "formsInput": { + "target": "com.amazonaws.datazone#FormInputList", "traits": { - "smithy.api#documentation": "

The data assets of the data product revision.

" + "smithy.api#documentation": "

The metadata forms of the data product.

" } }, - "formsInput": { - "target": "com.amazonaws.datazone#FormInputList", + "items": { + "target": "com.amazonaws.datazone#DataProductItems", "traits": { - "smithy.api#documentation": "

The metadata forms of the data product revision.

" + "smithy.api#documentation": "

The data assets of the data product.

" } }, "clientToken": { @@ -3184,41 +3919,41 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#CreateDataProductRevisionOutput": { + "com.amazonaws.datazone#CreateDataProductOutput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The ID of the domain where the data product lives.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.datazone#DataProductId", "traits": { - "smithy.api#documentation": "

The ID of the data product revision.

", + "smithy.api#documentation": "

The ID of the data product.

", "smithy.api#required": {} } }, "revision": { "target": "com.amazonaws.datazone#Revision", "traits": { - "smithy.api#documentation": "

The revision of the data product revision.

", + "smithy.api#documentation": "

The revision of the data product.

", "smithy.api#required": {} } }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the owning project of the data product revision.

", + "smithy.api#documentation": "

The ID of the owning project of the data product.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.datazone#DataProductName", "traits": { - "smithy.api#documentation": "

The name of the data product revision.

", + "smithy.api#documentation": "

The name of the data product.

", "smithy.api#required": {} } }, @@ -3226,50 +3961,50 @@ "target": "com.amazonaws.datazone#DataProductStatus", "traits": { "smithy.api#default": "CREATED", - "smithy.api#documentation": "

The status of the data product revision.

", + "smithy.api#documentation": "

The status of the data product.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.datazone#DataProductDescription", "traits": { - "smithy.api#documentation": "

The description of the data product revision.

" + "smithy.api#documentation": "

The description of the data product.

" } }, "glossaryTerms": { "target": "com.amazonaws.datazone#GlossaryTerms", "traits": { - "smithy.api#documentation": "

The glossary terms of the data product revision.

" + "smithy.api#documentation": "

The glossary terms of the data product.

" } }, "items": { "target": "com.amazonaws.datazone#DataProductItems", "traits": { - "smithy.api#documentation": "

The data assets of the data product revision.

" + "smithy.api#documentation": "

The data assets of the data product.

" } }, "formsOutput": { "target": "com.amazonaws.datazone#FormOutputList", "traits": { - "smithy.api#documentation": "

The metadata forms of the data product revision.

" + "smithy.api#documentation": "

The metadata forms of the data product.

" } }, "createdAt": { "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "

The timestamp at which the data product revision is created.

" + "smithy.api#documentation": "

The timestamp at which the data product was created.

" } }, "createdBy": { "target": "com.amazonaws.datazone#CreatedBy", "traits": { - "smithy.api#documentation": "

The user who created the data product revision.

" + "smithy.api#documentation": "

The user who created the data product.

" } }, "firstRevisionCreatedAt": { "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "

The timestamp at which the first revision of the data product is created.

" + "smithy.api#documentation": "

The timestamp at which the first revision of the data product was created.

" } }, "firstRevisionCreatedBy": { @@ -3283,13 +4018,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#CreateDataSource": { + "com.amazonaws.datazone#CreateDataProductRevision": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#CreateDataSourceInput" + "target": "com.amazonaws.datazone#CreateDataProductRevisionInput" }, "output": { - "target": "com.amazonaws.datazone#CreateDataSourceOutput" + "target": "com.amazonaws.datazone#CreateDataProductRevisionOutput" }, "errors": [ { @@ -3304,9 +4039,6 @@ { "target": "com.amazonaws.datazone#ResourceNotFoundException" }, - { - "target": "com.amazonaws.datazone#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -3315,43 +4047,246 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon DataZone data source.

", + "smithy.api#documentation": "

Creates a data product revision.

", "smithy.api#http": { "code": 201, "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/data-sources" + "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}/revisions" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.datazone#CreateDataSourceInput": { + "com.amazonaws.datazone#CreateDataProductRevisionInput": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.datazone#Name", - "traits": { - "smithy.api#documentation": "

The name of the data source.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.datazone#Description", - "traits": { - "smithy.api#documentation": "

The description of the data source.

" - } - }, "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "projectIdentifier": { - "target": "smithy.api#String", + "identifier": { + "target": "com.amazonaws.datazone#DataProductId", + "traits": { + "smithy.api#documentation": "

The ID of the data product revision.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DataProductName", + "traits": { + "smithy.api#documentation": "

The name of the data product revision.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DataProductDescription", + "traits": { + "smithy.api#documentation": "

The description of the data product revision.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms of the data product revision.

" + } + }, + "items": { + "target": "com.amazonaws.datazone#DataProductItems", + "traits": { + "smithy.api#documentation": "

The data assets of the data product revision.

" + } + }, + "formsInput": { + "target": "com.amazonaws.datazone#FormInputList", + "traits": { + "smithy.api#documentation": "

The metadata forms of the data product revision.

" + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateDataProductRevisionOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#DataProductId", + "traits": { + "smithy.api#documentation": "

The ID of the data product revision.

", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision of the data product revision.

", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the owning project of the data product revision.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DataProductName", + "traits": { + "smithy.api#documentation": "

The name of the data product revision.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataProductStatus", + "traits": { + "smithy.api#default": "CREATED", + "smithy.api#documentation": "

The status of the data product revision.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DataProductDescription", + "traits": { + "smithy.api#documentation": "

The description of the data product revision.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms of the data product revision.

" + } + }, + "items": { + "target": "com.amazonaws.datazone#DataProductItems", + "traits": { + "smithy.api#documentation": "

The data assets of the data product revision.

" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "

The metadata forms of the data product revision.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the data product revision is created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the data product revision.

" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the first revision of the data product is created.

" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the first revision of the data product.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateDataSourceInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateDataSourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon DataZone data source.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/data-sources" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateDataSourceInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the data source.

" + } + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the Amazon DataZone project in which you want to add this data\n source.

", + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$", "smithy.api#required": {} } }, @@ -3359,7 +4294,14 @@ "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", - "smithy.api#required": {} + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "connectionIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the connection.

", + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" } }, "type": { @@ -3470,8 +4412,13 @@ "environmentId": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} + "smithy.api#documentation": "

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

" + } + }, + "connectionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the connection.

" } }, "configuration": { @@ -3637,6 +4584,18 @@ "smithy.api#documentation": "

The tags specified for the Amazon DataZone domain.

" } }, + "domainVersion": { + "target": "com.amazonaws.datazone#DomainVersion", + "traits": { + "smithy.api#documentation": "

The version of the domain that is created.

" + } + }, + "serviceRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "

The service role of the domain that is created.

" + } + }, "clientToken": { "target": "smithy.api#String", "traits": { @@ -3718,6 +4677,18 @@ "traits": { "smithy.api#documentation": "

The tags specified for the Amazon DataZone domain.

" } + }, + "domainVersion": { + "target": "com.amazonaws.datazone#DomainVersion", + "traits": { + "smithy.api#documentation": "

The version of the domain that is created.

" + } + }, + "serviceRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "

Te service role of the domain that is created.

" + } } }, "traits": { @@ -4123,6 +5094,18 @@ "traits": { "smithy.api#documentation": "

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

" } + }, + "deploymentOrder": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The deployment order of the environment.

" + } + }, + "environmentConfigurationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The configuration ID of the environment.

" + } } }, "traits": { @@ -5195,13 +6178,33 @@ } } }, - "com.amazonaws.datazone#CreateProjectInput": { + "com.amazonaws.datazone#CreateProjectFromProjectProfilePolicyGrantDetail": { "type": "structure", "members": { - "domainIdentifier": { - "target": "com.amazonaws.datazone#DomainId", + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

Specifies whether to include child domain units when creating a project from project\n profile policy grant details

" + } + }, + "projectProfiles": { + "target": "com.amazonaws.datazone#ProjectProfileList", + "traits": { + "smithy.api#documentation": "

Specifies project profiles when creating a project from project profile policy grant\n details

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether to create a project from project profile policy grant details.

" + } + }, + "com.amazonaws.datazone#CreateProjectInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5230,6 +6233,18 @@ "traits": { "smithy.api#documentation": "

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

" } + }, + "projectProfileId": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile.

" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationUserParametersList", + "traits": { + "smithy.api#documentation": "

The user parameters of the project.

" + } } }, "traits": { @@ -5386,6 +6401,24 @@ "traits": { "smithy.api#documentation": "

The ID of the domain unit.

" } + }, + "projectProfileId": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The project profile ID.

" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationUserParametersList", + "traits": { + "smithy.api#documentation": "

The user parameters of the project.

" + } + }, + "environmentDeploymentDetails": { + "target": "com.amazonaws.datazone#EnvironmentDeploymentDetails", + "traits": { + "smithy.api#documentation": "

The environment deployment details.

" + } } }, "traits": { @@ -5406,6 +6439,167 @@ "smithy.api#documentation": "

The details of the policy grant.

" } }, + "com.amazonaws.datazone#CreateProjectProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateProjectProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateProjectProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a project profile.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/project-profiles" + } + } + }, + "com.amazonaws.datazone#CreateProjectProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

A domain ID of the project profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectProfileName", + "traits": { + "smithy.api#documentation": "

Project profile name.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

A description of a project profile.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#Status", + "traits": { + "smithy.api#documentation": "

Project profile status.

" + } + }, + "environmentConfigurations": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationsList", + "traits": { + "smithy.api#documentation": "

Environment configurations of the project profile.

" + } + }, + "domainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

A domain unit ID of the project profile.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateProjectProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where a project profile is created.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

Project profile ID.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectProfileName", + "traits": { + "smithy.api#documentation": "

Project profile name.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

A project profile description.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#Status", + "traits": { + "smithy.api#documentation": "

Project profile status.

" + } + }, + "environmentConfigurations": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationsList", + "traits": { + "smithy.api#documentation": "

Environment configurations of a project profile.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

A user who created a project profile.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp at which a project profile is created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp when a project profile was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit where a project profile is created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#CreateRule": { "type": "operation", "input": { @@ -5652,8 +6846,7 @@ "subscriptionTargetIdentifier": { "target": "com.amazonaws.datazone#SubscriptionTargetId", "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} + "smithy.api#documentation": "

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

" } }, "grantedEntity": { @@ -6047,7 +7240,7 @@ } }, "manageAccessRole": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#IamRoleArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} @@ -6157,10 +7350,9 @@ } }, "manageAccessRole": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#IamRoleArn", "traits": { - "smithy.api#documentation": "

The manage access role with which the subscription target was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The manage access role with which the subscription target was created.

" } }, "applicableAssetTypes": { @@ -6301,6 +7493,30 @@ "com.amazonaws.datazone#CreatedBy": { "type": "string" }, + "com.amazonaws.datazone#CredentialMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.datazone#CronString": { "type": "string", "traits": { @@ -6308,7 +7524,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}\\)" + "smithy.api#pattern": "cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) ([-?*,/\\dLW]){1,83} ([-*,/\\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\\dL]|[a-zA-Z]{3}){1,13} ([^\\)]+)\\)" } }, "com.amazonaws.datazone#CustomParameter": { @@ -6898,12 +8114,18 @@ "environmentId": { "target": "com.amazonaws.datazone#EnvironmentId" }, + "connectionId": { + "target": "smithy.api#String" + }, "projectIdentifier": { "target": "smithy.api#String" }, "environmentIdentifier": { "target": "smithy.api#String" }, + "connectionIdentifier": { + "target": "smithy.api#String" + }, "type": { "target": "com.amazonaws.datazone#DataSourceType" }, @@ -6983,6 +8205,12 @@ "traits": { "smithy.api#documentation": "

The configuration of the Amazon Redshift data source.

" } + }, + "sageMakerRunConfiguration": { + "target": "com.amazonaws.datazone#SageMakerRunConfigurationInput", + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker run configuration.

" + } } }, "traits": { @@ -7003,6 +8231,12 @@ "traits": { "smithy.api#documentation": "

The configuration of the Amazon Redshift data source.

" } + }, + "sageMakerRunConfiguration": { + "target": "com.amazonaws.datazone#SageMakerRunConfigurationOutput", + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker run configuration.

" + } } }, "traits": { @@ -7124,6 +8358,9 @@ "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage" }, + "lineageSummary": { + "target": "com.amazonaws.datazone#DataSourceRunLineageSummary" + }, "createdAt": { "target": "com.amazonaws.datazone#DateTime" }, @@ -7206,6 +8443,12 @@ "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage" }, + "lineageSummary": { + "target": "com.amazonaws.datazone#LineageInfo", + "traits": { + "smithy.api#documentation": "

The data lineage summary.

" + } + }, "createdAt": { "target": "com.amazonaws.datazone#DateTime", "traits": { @@ -7231,6 +8474,20 @@ "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" } }, + "com.amazonaws.datazone#DataSourceRunLineageSummary": { + "type": "structure", + "members": { + "importStatus": { + "target": "com.amazonaws.datazone#LineageImportStatus", + "traits": { + "smithy.api#documentation": "

The import status that's part of the run lineage summary of a data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The run lineage summary of a data source.

" + } + }, "com.amazonaws.datazone#DataSourceRunStatus": { "type": "enum", "members": { @@ -7341,6 +8598,12 @@ "traits": { "smithy.api#documentation": "

The timestamp of when a data source run was stopped.

" } + }, + "lineageSummary": { + "target": "com.amazonaws.datazone#DataSourceRunLineageSummary", + "traits": { + "smithy.api#documentation": "

The run lineage summary of a data source.

" + } } }, "traits": { @@ -7434,10 +8697,15 @@ } }, "environmentId": { - "target": "com.amazonaws.datazone#EnvironmentId", + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the environment in which the data source exists.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the environment in which the data source exists.

" + } + }, + "connectionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The connection ID that's part of the data source summary.

" } }, "dataSourceId": { @@ -7509,6 +8777,12 @@ "traits": { "smithy.api#documentation": "

The timestamp of when the data source was updated.

" } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The data source description.

" + } } }, "traits": { @@ -7549,6 +8823,9 @@ { "target": "com.amazonaws.datazone#CreateAssetFilter" }, + { + "target": "com.amazonaws.datazone#CreateConnection" + }, { "target": "com.amazonaws.datazone#CreateEnvironment" }, @@ -7570,6 +8847,9 @@ { "target": "com.amazonaws.datazone#CreateProjectMembership" }, + { + "target": "com.amazonaws.datazone#CreateProjectProfile" + }, { "target": "com.amazonaws.datazone#CreateSubscriptionGrant" }, @@ -7585,6 +8865,9 @@ { "target": "com.amazonaws.datazone#DeleteAssetFilter" }, + { + "target": "com.amazonaws.datazone#DeleteConnection" + }, { "target": "com.amazonaws.datazone#DeleteEnvironment" }, @@ -7600,6 +8883,9 @@ { "target": "com.amazonaws.datazone#DeleteProjectMembership" }, + { + "target": "com.amazonaws.datazone#DeleteProjectProfile" + }, { "target": "com.amazonaws.datazone#DeleteSubscriptionGrant" }, @@ -7618,6 +8904,9 @@ { "target": "com.amazonaws.datazone#GetAssetFilter" }, + { + "target": "com.amazonaws.datazone#GetConnection" + }, { "target": "com.amazonaws.datazone#GetEnvironment" }, @@ -7639,12 +8928,21 @@ { "target": "com.amazonaws.datazone#GetIamPortalLoginUrl" }, + { + "target": "com.amazonaws.datazone#GetJobRun" + }, + { + "target": "com.amazonaws.datazone#GetLineageEvent" + }, { "target": "com.amazonaws.datazone#GetLineageNode" }, { "target": "com.amazonaws.datazone#GetProject" }, + { + "target": "com.amazonaws.datazone#GetProjectProfile" + }, { "target": "com.amazonaws.datazone#GetSubscription" }, @@ -7669,6 +8967,9 @@ { "target": "com.amazonaws.datazone#ListAssetRevisions" }, + { + "target": "com.amazonaws.datazone#ListConnections" + }, { "target": "com.amazonaws.datazone#ListDataProductRevisions" }, @@ -7690,6 +8991,12 @@ { "target": "com.amazonaws.datazone#ListEnvironments" }, + { + "target": "com.amazonaws.datazone#ListJobRuns" + }, + { + "target": "com.amazonaws.datazone#ListLineageEvents" + }, { "target": "com.amazonaws.datazone#ListLineageNodeHistory" }, @@ -7702,6 +9009,9 @@ { "target": "com.amazonaws.datazone#ListProjectMemberships" }, + { + "target": "com.amazonaws.datazone#ListProjectProfiles" + }, { "target": "com.amazonaws.datazone#ListProjects" }, @@ -7768,6 +9078,9 @@ { "target": "com.amazonaws.datazone#UpdateAssetFilter" }, + { + "target": "com.amazonaws.datazone#UpdateConnection" + }, { "target": "com.amazonaws.datazone#UpdateEnvironment" }, @@ -7783,6 +9096,9 @@ { "target": "com.amazonaws.datazone#UpdateProject" }, + { + "target": "com.amazonaws.datazone#UpdateProjectProfile" + }, { "target": "com.amazonaws.datazone#UpdateSubscriptionGrantStatus" }, @@ -8498,21 +9814,18 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#DeleteDataProduct": { + "com.amazonaws.datazone#DeleteConnection": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#DeleteDataProductInput" + "target": "com.amazonaws.datazone#DeleteConnectionInput" }, "output": { - "target": "com.amazonaws.datazone#DeleteDataProductOutput" + "target": "com.amazonaws.datazone#DeleteConnectionOutput" }, "errors": [ { "target": "com.amazonaws.datazone#AccessDeniedException" }, - { - "target": "com.amazonaws.datazone#ConflictException" - }, { "target": "com.amazonaws.datazone#InternalServerException" }, @@ -8527,11 +9840,87 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a data product in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes and connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { - "code": 204, + "code": 202, "method": "DELETE", - "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/connections/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteConnectionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the connection is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ConnectionId", + "traits": { + "smithy.api#documentation": "

The ID of the connection that is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteConnectionOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteDataProduct": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteDataProductInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteDataProductOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a data product in Amazon DataZone.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}" }, "smithy.api#idempotent": {} } @@ -8630,6 +10019,10 @@ "clientToken": { "target": "smithy.api#String", "traits": { + "smithy.api#deprecated": { + "message": "This field is no longer required for idempotency.", + "since": "2024-12-02" + }, "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} @@ -8699,8 +10092,13 @@ "environmentId": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The ID of the environemnt associated with this data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the environemnt associated with this data source.

" + } + }, + "connectionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the connection that is deleted.

" } }, "configuration": { @@ -9624,6 +11022,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#DeleteProjectProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteProjectProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteProjectProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a project profile.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/project-profiles/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteProjectProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where a project profile is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile that is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteProjectProfileOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#DeleteRule": { "type": "operation", "input": { @@ -10112,6 +11576,32 @@ "target": "com.amazonaws.datazone#DeploymentMessage" } }, + "com.amazonaws.datazone#DeploymentMode": { + "type": "enum", + "members": { + "ON_CREATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_CREATE" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + } + } + }, + "com.amazonaws.datazone#DeploymentOrder": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 16 + } + } + }, "com.amazonaws.datazone#DeploymentProperties": { "type": "structure", "members": { @@ -10349,6 +11839,12 @@ }, "lastUpdatedAt": { "target": "com.amazonaws.datazone#UpdatedAt" + }, + "domainVersion": { + "target": "com.amazonaws.datazone#DomainVersion" + }, + "serviceRole": { + "target": "com.amazonaws.datazone#RoleArn" } }, "create": { @@ -10494,6 +11990,12 @@ "traits": { "smithy.api#documentation": "

A timestamp of when a Amazon DataZone domain was last updated.

" } + }, + "domainVersion": { + "target": "com.amazonaws.datazone#DomainVersion", + "traits": { + "smithy.api#documentation": "

The domain version.

" + } } }, "traits": { @@ -10786,6 +12288,23 @@ "smithy.api#documentation": "

The properties of the domain unit user.

" } }, + "com.amazonaws.datazone#DomainVersion": { + "type": "enum", + "members": { + "V1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V1" + } + }, + "V2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V2" + } + } + } + }, "com.amazonaws.datazone#EdgeDirection": { "type": "enum", "members": { @@ -10960,6 +12479,9 @@ "manageAccessRoleArn": { "target": "com.amazonaws.datazone#RoleArn" }, + "environmentRolePermissionBoundary": { + "target": "com.amazonaws.datazone#PolicyArn" + }, "enabledRegions": { "target": "com.amazonaws.datazone#EnabledRegionList" }, @@ -11009,6 +12531,12 @@ "smithy.api#documentation": "

The ARN of the provisioning role specified in the environment blueprint\n configuration.

" } }, + "environmentRolePermissionBoundary": { + "target": "com.amazonaws.datazone#PolicyArn", + "traits": { + "smithy.api#documentation": "

The environment role permission boundary.

" + } + }, "manageAccessRoleArn": { "target": "com.amazonaws.datazone#RoleArn", "traits": { @@ -11136,34 +12664,80 @@ "smithy.api#documentation": "

The details of an environment blueprint summary.

" } }, - "com.amazonaws.datazone#EnvironmentError": { + "com.amazonaws.datazone#EnvironmentConfiguration": { "type": "structure", "members": { - "code": { - "target": "smithy.api#String", + "name": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationName", "traits": { - "smithy.api#documentation": "

The error code for the failure reason for the environment deployment.

" + "smithy.api#documentation": "

The environment name.

", + "smithy.api#required": {} } }, - "message": { - "target": "smithy.api#String", + "id": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationId", "traits": { - "smithy.api#documentation": "

The error message for the failure reason for the environment deployment.

", + "smithy.api#documentation": "

The environment ID.

" + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "

The environment blueprint ID.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The environment description.

" + } + }, + "deploymentMode": { + "target": "com.amazonaws.datazone#DeploymentMode", + "traits": { + "smithy.api#documentation": "

The deployment mode of the environment.

" + } + }, + "configurationParameters": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationParametersDetails", + "traits": { + "smithy.api#documentation": "

The configuration parameters of the environment.

" + } + }, + "awsAccount": { + "target": "com.amazonaws.datazone#AwsAccount", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account of the environment.

", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.datazone#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region of the environment.

", "smithy.api#required": {} } + }, + "deploymentOrder": { + "target": "com.amazonaws.datazone#DeploymentOrder", + "traits": { + "smithy.api#documentation": "

The deployment order of the environment.

" + } } }, "traits": { - "smithy.api#documentation": "

The failure reasons for the environment deployment.

" + "smithy.api#documentation": "

The configuration of an environment.

" } }, - "com.amazonaws.datazone#EnvironmentId": { + "com.amazonaws.datazone#EnvironmentConfigurationId": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$", + "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#EnvironmentName": { + "com.amazonaws.datazone#EnvironmentConfigurationName": { "type": "string", "traits": { "smithy.api#length": { @@ -11174,50 +12748,219 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#EnvironmentParameter": { + "com.amazonaws.datazone#EnvironmentConfigurationParameter": { "type": "structure", "members": { "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#EnvironmentConfigurationParameterName", "traits": { - "smithy.api#documentation": "

The name of an environment profile parameter.

" + "smithy.api#documentation": "

The name of the environment configuration parameter.

" } }, "value": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The value of an environment profile parameter.

" + "smithy.api#documentation": "

The value of the environment configuration parameter.

" + } + }, + "isEditable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the environment parameter is editable.

" } } }, "traits": { - "smithy.api#documentation": "

The parameter details of an evironment profile.

" - } - }, - "com.amazonaws.datazone#EnvironmentParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#EnvironmentParameter" + "smithy.api#documentation": "

The environment configuration parameter.

" } }, - "com.amazonaws.datazone#EnvironmentProfileId": { + "com.amazonaws.datazone#EnvironmentConfigurationParameterName": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{0,36}$" + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" } }, - "com.amazonaws.datazone#EnvironmentProfileName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "com.amazonaws.datazone#EnvironmentConfigurationParametersDetails": { + "type": "structure", + "members": { + "ssmPath": { + "target": "com.amazonaws.datazone#ParameterStorePath", + "traits": { + "smithy.api#documentation": "

Ssm path environment configuration parameters.

" + } }, - "smithy.api#pattern": "^[\\w -]+$", - "smithy.api#sensitive": {} + "parameterOverrides": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationParametersList", + "traits": { + "smithy.api#documentation": "

The parameter overrides.

" + } + }, + "resolvedParameters": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationParametersList", + "traits": { + "smithy.api#documentation": "

The resolved environment configuration parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the environment configuration parameter.

" } }, - "com.amazonaws.datazone#EnvironmentProfileSummaries": { + "com.amazonaws.datazone#EnvironmentConfigurationParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationParameter" + } + }, + "com.amazonaws.datazone#EnvironmentConfigurationUserParameter": { + "type": "structure", + "members": { + "environmentConfigurationName": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationName", + "traits": { + "smithy.api#documentation": "

The environment configuration name.

" + } + }, + "environmentParameters": { + "target": "com.amazonaws.datazone#EnvironmentParametersList", + "traits": { + "smithy.api#documentation": "

The environment parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The environment configuration user parameters.

" + } + }, + "com.amazonaws.datazone#EnvironmentConfigurationUserParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationUserParameter" + } + }, + "com.amazonaws.datazone#EnvironmentConfigurationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentConfiguration" + } + }, + "com.amazonaws.datazone#EnvironmentDeploymentDetails": { + "type": "structure", + "members": { + "overallDeploymentStatus": { + "target": "com.amazonaws.datazone#OverallDeploymentStatus", + "traits": { + "smithy.api#documentation": "

The overall deployment status of the environment.

" + } + }, + "environmentFailureReasons": { + "target": "com.amazonaws.datazone#EnvironmentFailureReasons", + "traits": { + "smithy.api#documentation": "

Environment failure reasons.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The environment deployment details.

" + } + }, + "com.amazonaws.datazone#EnvironmentError": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error code for the failure reason for the environment deployment.

" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message for the failure reason for the environment deployment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The failure reasons for the environment deployment.

" + } + }, + "com.amazonaws.datazone#EnvironmentFailureReasons": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.datazone#EnvironmentFailureReasonsList" + } + }, + "com.amazonaws.datazone#EnvironmentFailureReasonsList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentError" + } + }, + "com.amazonaws.datazone#EnvironmentId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EnvironmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#EnvironmentParameter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of an environment profile parameter.

" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value of an environment profile parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameter details of an evironment profile.

" + } + }, + "com.amazonaws.datazone#EnvironmentParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentParameter" + } + }, + "com.amazonaws.datazone#EnvironmentProfileId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{0,36}$" + } + }, + "com.amazonaws.datazone#EnvironmentProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#EnvironmentProfileSummaries": { "type": "list", "member": { "target": "com.amazonaws.datazone#EnvironmentProfileSummary" @@ -11513,14 +13256,38 @@ "com.amazonaws.datazone#ErrorMessage": { "type": "string" }, + "com.amazonaws.datazone#EventSummary": { + "type": "union", + "members": { + "openLineageRunEventSummary": { + "target": "com.amazonaws.datazone#OpenLineageRunEventSummary", + "traits": { + "smithy.api#documentation": "

The open lineage run event summary.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The event summary.

" + } + }, "com.amazonaws.datazone#ExternalIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 256 - }, - "smithy.api#sensitive": {} + "max": 600 + } + } + }, + "com.amazonaws.datazone#FailedQueryProcessingErrorMessages": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } } }, "com.amazonaws.datazone#FailureCause": { @@ -12558,13 +14325,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#GetDataProduct": { + "com.amazonaws.datazone#GetConnection": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#GetDataProductInput" + "target": "com.amazonaws.datazone#GetConnectionInput" }, "output": { - "target": "com.amazonaws.datazone#GetDataProductOutput" + "target": "com.amazonaws.datazone#GetConnectionOutput" }, "errors": [ { @@ -12584,39 +14351,39 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the data product.

", + "smithy.api#documentation": "

Gets a connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/connections/{identifier}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#GetDataProductInput": { + "com.amazonaws.datazone#GetConnectionInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain where the data product lives.

", + "smithy.api#documentation": "

The ID of the domain where we get the connection.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "identifier": { - "target": "com.amazonaws.datazone#DataProductId", + "target": "com.amazonaws.datazone#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the data product.

", + "smithy.api#documentation": "

The connection ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "revision": { - "target": "com.amazonaws.datazone#Revision", + "withSecret": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The revision of the data product.

", - "smithy.api#httpQuery": "revision" + "smithy.api#documentation": "

Specifies whether a connection has a secret.

", + "smithy.api#httpQuery": "withSecret" } } }, @@ -12624,98 +14391,85 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#GetDataProductOutput": { + "com.amazonaws.datazone#GetConnectionOutput": { "type": "structure", "members": { - "domainId": { - "target": "com.amazonaws.datazone#DomainId", - "traits": { - "smithy.api#documentation": "

The ID of the domain where the data product lives.

", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.datazone#DataProductId", + "connectionCredentials": { + "target": "com.amazonaws.datazone#ConnectionCredentials", "traits": { - "smithy.api#documentation": "

The ID of the data product.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Connection credentials.

" } }, - "revision": { - "target": "com.amazonaws.datazone#Revision", + "connectionId": { + "target": "com.amazonaws.datazone#ConnectionId", "traits": { - "smithy.api#documentation": "

The revision of the data product.

", + "smithy.api#documentation": "

The ID of the connection.

", "smithy.api#required": {} } }, - "owningProjectId": { - "target": "com.amazonaws.datazone#ProjectId", + "description": { + "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The ID of the owning project of the data product.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Connection description.

" } }, - "name": { - "target": "com.amazonaws.datazone#DataProductName", + "domainId": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The name of the data product.

", + "smithy.api#documentation": "

The domain ID of the connection.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.datazone#DataProductStatus", + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#default": "CREATED", - "smithy.api#documentation": "

The status of the data product.

", + "smithy.api#documentation": "

The domain unit ID of the connection.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.datazone#DataProductDescription", - "traits": { - "smithy.api#documentation": "

The description of the data product.

" - } - }, - "glossaryTerms": { - "target": "com.amazonaws.datazone#GlossaryTerms", + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The glossary terms of the data product.

" + "smithy.api#documentation": "

The ID of the environment.

" } }, - "items": { - "target": "com.amazonaws.datazone#DataProductItems", + "environmentUserRole": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data assets of the data product.

" + "smithy.api#documentation": "

The environment user role.

" } }, - "formsOutput": { - "target": "com.amazonaws.datazone#FormOutputList", + "name": { + "target": "com.amazonaws.datazone#ConnectionName", "traits": { - "smithy.api#documentation": "

The metadata forms of the data product.

" + "smithy.api#documentation": "

The name of the connection.

", + "smithy.api#required": {} } }, - "createdAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "physicalEndpoints": { + "target": "com.amazonaws.datazone#PhysicalEndpoints", "traits": { - "smithy.api#documentation": "

The timestamp at which the data product is created.

" + "smithy.api#documentation": "

The physical endpoints of the connection.

", + "smithy.api#required": {} } }, - "createdBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The user who created the data product.

" + "smithy.api#documentation": "

The ID of the project.

" } }, - "firstRevisionCreatedAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "props": { + "target": "com.amazonaws.datazone#ConnectionPropertiesOutput", "traits": { - "smithy.api#documentation": "

The timestamp at which the first revision of the data product is created.

" + "smithy.api#documentation": "

Connection props.

" } }, - "firstRevisionCreatedBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "type": { + "target": "com.amazonaws.datazone#ConnectionType", "traits": { - "smithy.api#documentation": "

The user who created the first revision of the data product.

" + "smithy.api#documentation": "

The type of the connection.

", + "smithy.api#required": {} } } }, @@ -12723,30 +14477,24 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#GetDataSource": { + "com.amazonaws.datazone#GetDataProduct": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#GetDataSourceInput" + "target": "com.amazonaws.datazone#GetDataProductInput" }, "output": { - "target": "com.amazonaws.datazone#GetDataSourceOutput" + "target": "com.amazonaws.datazone#GetDataProductOutput" }, "errors": [ { "target": "com.amazonaws.datazone#AccessDeniedException" }, - { - "target": "com.amazonaws.datazone#ConflictException" - }, { "target": "com.amazonaws.datazone#InternalServerException" }, { "target": "com.amazonaws.datazone#ResourceNotFoundException" }, - { - "target": "com.amazonaws.datazone#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -12755,22 +14503,193 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an Amazon DataZone data source.

", + "smithy.api#documentation": "

Gets the data product.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/data-sources/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#GetDataSourceInput": { + "com.amazonaws.datazone#GetDataProductInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the data source exists.

", + "smithy.api#documentation": "

The ID of the domain where the data product lives.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DataProductId", + "traits": { + "smithy.api#documentation": "

The ID of the data product.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision of the data product.

", + "smithy.api#httpQuery": "revision" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetDataProductOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the data product lives.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#DataProductId", + "traits": { + "smithy.api#documentation": "

The ID of the data product.

", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision of the data product.

", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the owning project of the data product.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DataProductName", + "traits": { + "smithy.api#documentation": "

The name of the data product.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataProductStatus", + "traits": { + "smithy.api#default": "CREATED", + "smithy.api#documentation": "

The status of the data product.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DataProductDescription", + "traits": { + "smithy.api#documentation": "

The description of the data product.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms of the data product.

" + } + }, + "items": { + "target": "com.amazonaws.datazone#DataProductItems", + "traits": { + "smithy.api#documentation": "

The data assets of the data product.

" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "

The metadata forms of the data product.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the data product is created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the data product.

" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the first revision of the data product is created.

" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the first revision of the data product.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetDataSourceInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetDataSourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an Amazon DataZone data source.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/data-sources/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetDataSourceInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the data source exists.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12840,8 +14759,13 @@ "environmentId": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The ID of the environment where this data source creates and publishes assets,

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the environment where this data source creates and publishes assets,

" + } + }, + "connectionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the connection.

" } }, "configuration": { @@ -13057,6 +14981,12 @@ "smithy.api#documentation": "

The asset statistics from this data source run.

" } }, + "lineageSummary": { + "target": "com.amazonaws.datazone#DataSourceRunLineageSummary", + "traits": { + "smithy.api#documentation": "

The summary of the data lineage.

" + } + }, "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { @@ -13234,6 +15164,18 @@ "traits": { "smithy.api#documentation": "

The tags specified for the Amazon DataZone domain.

" } + }, + "domainVersion": { + "target": "com.amazonaws.datazone#DomainVersion", + "traits": { + "smithy.api#documentation": "

The version of the domain.

" + } + }, + "serviceRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "

The service role of the domain.

" + } } }, "traits": { @@ -13642,6 +15584,12 @@ "smithy.api#documentation": "

The ARN of the provisioning role with which this blueprint is created.

" } }, + "environmentRolePermissionBoundary": { + "target": "com.amazonaws.datazone#PolicyArn", + "traits": { + "smithy.api#documentation": "

The environment role permissions boundary.

" + } + }, "manageAccessRoleArn": { "target": "com.amazonaws.datazone#RoleArn", "traits": { @@ -14781,13 +16729,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#GetLineageNode": { + "com.amazonaws.datazone#GetJobRun": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#GetLineageNodeInput" + "target": "com.amazonaws.datazone#GetJobRunInput" }, "output": { - "target": "com.amazonaws.datazone#GetLineageNodeOutput" + "target": "com.amazonaws.datazone#GetJobRunOutput" }, "errors": [ { @@ -14807,132 +16755,387 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the data lineage node.

", + "smithy.api#documentation": "

The details of the job run.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/lineage/nodes/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/jobRuns/{identifier}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#GetLineageNodeInput": { + "com.amazonaws.datazone#GetJobRunInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain in which you want to get the data lineage node.

", + "smithy.api#documentation": "

The ID of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "identifier": { - "target": "com.amazonaws.datazone#LineageNodeIdentifier", + "target": "com.amazonaws.datazone#RunIdentifier", "traits": { - "smithy.api#documentation": "

The ID of the data lineage node that you want to get.

\n

Both, a lineage node identifier generated by Amazon DataZone and a\n sourceIdentifier of the lineage node are supported. If\n sourceIdentifier is greater than 1800 characters, you can use lineage node\n identifier generated by Amazon DataZone to get the node details.

", + "smithy.api#documentation": "

The ID of the job run.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "eventTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The event time stamp for which you want to get the data lineage node.

", - "smithy.api#httpQuery": "timestamp" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.datazone#GetLineageNodeOutput": { + "com.amazonaws.datazone#GetJobRunOutput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain where you're getting the data lineage node.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the domain.

" } }, - "name": { + "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the data lineage node.

" + "smithy.api#documentation": "

The ID of the job run.

" } }, - "description": { + "jobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The description of the data lineage node.

" + "smithy.api#documentation": "

The ID of the job run.

" } }, - "createdAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "jobType": { + "target": "com.amazonaws.datazone#JobType", "traits": { - "smithy.api#documentation": "

The timestamp at which the data lineage node was created.

" + "smithy.api#documentation": "

The type of the job run.

" } }, - "createdBy": { - "target": "com.amazonaws.datazone#CreatedBy", + "runMode": { + "target": "com.amazonaws.datazone#JobRunMode", "traits": { - "smithy.api#documentation": "

The user who created the data lineage node.

" + "smithy.api#documentation": "

The mode of the job run.

" } }, - "updatedAt": { - "target": "com.amazonaws.datazone#UpdatedAt", + "details": { + "target": "com.amazonaws.datazone#JobRunDetails", "traits": { - "smithy.api#documentation": "

The timestamp at which the data lineage node was updated.

" + "smithy.api#documentation": "

The details of the job run.

" } }, - "updatedBy": { - "target": "com.amazonaws.datazone#UpdatedBy", + "status": { + "target": "com.amazonaws.datazone#JobRunStatus", "traits": { - "smithy.api#documentation": "

The user who updated the data lineage node.

" + "smithy.api#documentation": "

The status of the job run.

" } }, - "id": { - "target": "com.amazonaws.datazone#LineageNodeId", + "error": { + "target": "com.amazonaws.datazone#JobRunError", "traits": { - "smithy.api#documentation": "

The ID of the data lineage node.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The error generated if the action is not completed successfully.

" } }, - "typeName": { + "createdBy": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the type of the specified data lineage node.

", - "smithy.api#required": {} - } - }, - "typeRevision": { - "target": "com.amazonaws.datazone#Revision", - "traits": { - "smithy.api#documentation": "

The revision type of the specified data lineage node.

" + "smithy.api#documentation": "

The user who created the job run.

" } }, - "sourceIdentifier": { - "target": "smithy.api#String", + "createdAt": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The source identifier of the data lineage node.

" + "smithy.api#documentation": "

The timestamp of when the job run was created.

" } }, - "eventTimestamp": { + "startTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp of the event described in the data lineage node.

" + "smithy.api#documentation": "

The timestamp of when the job run started.

" } }, - "formsOutput": { - "target": "com.amazonaws.datazone#FormOutputList", + "endTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The metadata of the specified data lineage node.

" + "smithy.api#documentation": "

The timestamp of when the job run ended.

" } - }, - "upstreamNodes": { - "target": "com.amazonaws.datazone#LineageNodeReferenceList", + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetLineageEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetLineageEventInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetLineageEventOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the lineage event.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/lineage/events/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetLineageEventInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#LineageEventIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the lineage event.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetLineageEventOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain.

", + "smithy.api#httpHeader": "Domain-Id" + } + }, + "id": { + "target": "com.amazonaws.datazone#LineageEventIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the lineage event.

", + "smithy.api#httpHeader": "Id" + } + }, + "event": { + "target": "com.amazonaws.datazone#LineageEvent", + "traits": { + "smithy.api#documentation": "

The lineage event details.

", + "smithy.api#httpPayload": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the lineage event.

", + "smithy.api#httpHeader": "Created-By" + } + }, + "processingStatus": { + "target": "com.amazonaws.datazone#LineageEventProcessingStatus", + "traits": { + "smithy.api#documentation": "

The progressing status of the lineage event.

", + "smithy.api#httpHeader": "Processing-Status" + } + }, + "eventTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time of the lineage event.

", + "smithy.api#httpHeader": "Event-Time" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp of when the lineage event was created.

", + "smithy.api#httpHeader": "Created-At" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetLineageNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetLineageNodeInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetLineageNodeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the data lineage node.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/lineage/nodes/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetLineageNodeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain in which you want to get the data lineage node.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#LineageNodeIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the data lineage node that you want to get.

\n

Both, a lineage node identifier generated by Amazon DataZone and a\n sourceIdentifier of the lineage node are supported. If\n sourceIdentifier is greater than 1800 characters, you can use lineage node\n identifier generated by Amazon DataZone to get the node details.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The event time stamp for which you want to get the data lineage node.

", + "smithy.api#httpQuery": "timestamp" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetLineageNodeOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you're getting the data lineage node.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the data lineage node.

" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The description of the data lineage node.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the data lineage node was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the data lineage node.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the data lineage node was updated.

" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user who updated the data lineage node.

" + } + }, + "id": { + "target": "com.amazonaws.datazone#LineageNodeId", + "traits": { + "smithy.api#documentation": "

The ID of the data lineage node.

", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the type of the specified data lineage node.

", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "

The revision type of the specified data lineage node.

" + } + }, + "sourceIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The source identifier of the data lineage node.

" + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the event described in the data lineage node.

" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "

The metadata of the specified data lineage node.

" + } + }, + "upstreamNodes": { + "target": "com.amazonaws.datazone#LineageNodeReferenceList", "traits": { "smithy.api#documentation": "

The upstream nodes of the specified data lineage node.

" } @@ -15343,6 +17546,157 @@ "traits": { "smithy.api#documentation": "

The ID of the domain unit.

" } + }, + "projectProfileId": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile of a project.

" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationUserParametersList", + "traits": { + "smithy.api#documentation": "

The user parameters of a project.

" + } + }, + "environmentDeploymentDetails": { + "target": "com.amazonaws.datazone#EnvironmentDeploymentDetails", + "traits": { + "smithy.api#documentation": "

The environment deployment status of a project.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetProjectProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetProjectProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetProjectProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The details of the project profile.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/project-profiles/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetProjectProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetProjectProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain of the project profile.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectProfileName", + "traits": { + "smithy.api#documentation": "

The name of the project profile.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the project profile.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#Status", + "traits": { + "smithy.api#documentation": "

The status of the project profile.

" + } + }, + "environmentConfigurations": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationsList", + "traits": { + "smithy.api#documentation": "

The environment configurations of the project profile.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the project profile.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the project profile was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when project profile was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit of the project profile.

" + } } }, "traits": { @@ -16118,10 +18472,9 @@ } }, "manageAccessRole": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#IamRoleArn", "traits": { - "smithy.api#documentation": "

The manage access role with which the subscription target was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The manage access role with which the subscription target was created.

" } }, "applicableAssetTypes": { @@ -16739,100 +19092,559 @@ } } }, - "com.amazonaws.datazone#GlueRunConfigurationInput": { + "com.amazonaws.datazone#GlueConnection": { "type": "structure", "members": { - "dataAccessRole": { + "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data\n source.

", - "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + "smithy.api#documentation": "

The name of the Amazon Web Services Glue connection.

" } }, - "relationalFilterConfigurations": { - "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "description": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the Amazon Web Services Glue connection.

", + "smithy.api#length": { + "min": 0, + "max": 2048 + } } }, - "autoImportDataQualityResult": { - "target": "smithy.api#Boolean", + "connectionType": { + "target": "com.amazonaws.datazone#ConnectionType", "traits": { - "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data\n source run.

" + "smithy.api#documentation": "

The type of the Amazon Web Services Glue connection.

" + } + }, + "matchCriteria": { + "target": "com.amazonaws.datazone#MatchCriteria", + "traits": { + "smithy.api#documentation": "

The match criteria of the Amazon Web Services Glue connection.

" + } + }, + "connectionProperties": { + "target": "com.amazonaws.datazone#ConnectionProperties", + "traits": { + "smithy.api#documentation": "

The properties of the Amazon Web Services Glue connection.

" + } + }, + "sparkProperties": { + "target": "com.amazonaws.datazone#PropertyMap", + "traits": { + "smithy.api#documentation": "

The Spark properties of the Amazon Web Services Glue connection.

" + } + }, + "athenaProperties": { + "target": "com.amazonaws.datazone#PropertyMap", + "traits": { + "smithy.api#documentation": "

The Amazon Athena properties of the Amazon Web Services Glue connection.

" + } + }, + "pythonProperties": { + "target": "com.amazonaws.datazone#PropertyMap", + "traits": { + "smithy.api#documentation": "

The Python properties of the Amazon Web Services Glue connection.

" + } + }, + "physicalConnectionRequirements": { + "target": "com.amazonaws.datazone#PhysicalConnectionRequirements", + "traits": { + "smithy.api#documentation": "

The physical connection requirements of the Amazon Web Services Glue connection.

" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the Amazon Web Services Glue connection.

" + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the Amazon Web Services Glue connection was last updated.

" + } + }, + "lastUpdatedBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The user who last updated the Amazon Web Services Glue connection.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#ConnectionStatus", + "traits": { + "smithy.api#documentation": "

The status of the Amazon Web Services Glue connection.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status reason of the Amazon Web Services Glue connection.

", + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, + "lastConnectionValidationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The last validation time of the Amazon Web Services Glue connection.

" + } + }, + "authenticationConfiguration": { + "target": "com.amazonaws.datazone#AuthenticationConfiguration", + "traits": { + "smithy.api#documentation": "

The authentication configuration of the Amazon Web Services Glue connection.

" + } + }, + "connectionSchemaVersion": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The connection schema version of the Amazon Web Services Glue connection.

", + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, + "compatibleComputeEnvironments": { + "target": "com.amazonaws.datazone#ComputeEnvironmentsList", + "traits": { + "smithy.api#documentation": "

The compatible compute environments of the Amazon Web Services Glue connection.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration details of the Amazon Web Services Glue data source.

" + "smithy.api#documentation": "

The Amazon Web Services Glue connection.

" } }, - "com.amazonaws.datazone#GlueRunConfigurationOutput": { + "com.amazonaws.datazone#GlueConnectionInput": { "type": "structure", "members": { - "accountId": { - "target": "smithy.api#String", + "connectionProperties": { + "target": "com.amazonaws.datazone#ConnectionProperties", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data\n source.

", - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^\\d{12}$" + "smithy.api#documentation": "

The connection properties of the Amazon Web Services Glue connection.

" } }, - "region": { + "physicalConnectionRequirements": { + "target": "com.amazonaws.datazone#PhysicalConnectionRequirements", + "traits": { + "smithy.api#documentation": "

The physical connection requirements for the Amazon Web Services Glue connection.

" + } + }, + "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.\n

", + "smithy.api#documentation": "

The name of the Amazon Web Services Glue connection.

", "smithy.api#length": { - "min": 4, - "max": 16 - }, - "smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" + "min": 1, + "max": 255 + } } }, - "dataAccessRole": { + "description": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data\n source.

", - "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + "smithy.api#documentation": "

The description of the Amazon Web Services Glue connection.

" } }, - "relationalFilterConfigurations": { - "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "connectionType": { + "target": "com.amazonaws.datazone#GlueConnectionType", "traits": { - "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The connection type of the Amazon Web Services Glue connection.

" } }, - "autoImportDataQualityResult": { + "matchCriteria": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The match criteria of the Amazon Web Services Glue connection.

", + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "validateCredentials": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data\n source run.

" + "smithy.api#documentation": "

Speciefies whether to validate credentials of the Amazon Web Services Glue connection.

" + } + }, + "validateForComputeEnvironments": { + "target": "com.amazonaws.datazone#ComputeEnvironmentsList", + "traits": { + "smithy.api#documentation": "

Speciefies whether to validate for compute environments of the Amazon Web Services Glue connection.

" + } + }, + "sparkProperties": { + "target": "com.amazonaws.datazone#PropertyMap", + "traits": { + "smithy.api#documentation": "

The Spark properties of the Amazon Web Services Glue connection.

" + } + }, + "athenaProperties": { + "target": "com.amazonaws.datazone#PropertyMap", + "traits": { + "smithy.api#documentation": "

The Amazon Athena properties of the Amazon Web Services Glue connection.

" + } + }, + "pythonProperties": { + "target": "com.amazonaws.datazone#PropertyMap", + "traits": { + "smithy.api#documentation": "

The Python properties of the Amazon Web Services Glue connection.

" + } + }, + "authenticationConfiguration": { + "target": "com.amazonaws.datazone#AuthenticationConfigurationInput", + "traits": { + "smithy.api#documentation": "

The authentication configuration of the Amazon Web Services Glue connection.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration details of the Amazon Web Services Glue data source.

" + "smithy.api#documentation": "

The Amazon Web Services Glue connecton input.

" } }, - "com.amazonaws.datazone#GlueSelfGrantStatusOutput": { + "com.amazonaws.datazone#GlueConnectionPatch": { "type": "structure", "members": { - "selfGrantStatusDetails": { - "target": "com.amazonaws.datazone#SelfGrantStatusDetails", + "description": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The details for the self granting status for a Glue data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the Amazon Web Services Glue connection patch.

" + } + }, + "connectionProperties": { + "target": "com.amazonaws.datazone#ConnectionProperties", + "traits": { + "smithy.api#documentation": "

The properties of the Amazon Web Services Glue connection patch.

" + } + }, + "authenticationConfiguration": { + "target": "com.amazonaws.datazone#AuthenticationConfigurationPatch", + "traits": { + "smithy.api#documentation": "

The authentication configuration of the Amazon Web Services Glue connection patch.

" } } }, "traits": { - "smithy.api#documentation": "

The details of the self granting status.

" + "smithy.api#documentation": "

The Amazon Web Services Glue connection patch.

" } }, - "com.amazonaws.datazone#GrantedEntity": { + "com.amazonaws.datazone#GlueConnectionType": { + "type": "enum", + "members": { + "SNOWFLAKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNOWFLAKE" + } + }, + "BIGQUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGQUERY" + } + }, + "DOCUMENTDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENTDB" + } + }, + "DYNAMODB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB" + } + }, + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH" + } + }, + "ORACLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + }, + "SAPHANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAPHANA" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + }, + "TERADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERADATA" + } + }, + "VERTICA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICA" + } + } + } + }, + "com.amazonaws.datazone#GlueOAuth2Credentials": { + "type": "structure", + "members": { + "userManagedClientApplicationClientSecret": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The user managed client application client secret of the connection.

", + "smithy.api#length": { + "max": 512 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$" + } + }, + "accessToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The access token of a connection.

", + "smithy.api#length": { + "max": 4096 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$" + } + }, + "refreshToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The refresh token of the connection.

", + "smithy.api#length": { + "max": 4096 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$" + } + }, + "jwtToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The jwt token of the connection.

", + "smithy.api#length": { + "max": 8000 + }, + "smithy.api#pattern": "^([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_\\-\\+\\/=]*)$" + } + } + }, + "traits": { + "smithy.api#documentation": "

The GlueOAuth2 credentials of a connection.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#GluePropertiesInput": { + "type": "structure", + "members": { + "glueConnectionInput": { + "target": "com.amazonaws.datazone#GlueConnectionInput", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue properties of a connection.

" + } + }, + "com.amazonaws.datazone#GluePropertiesOutput": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.datazone#ConnectionStatus", + "traits": { + "smithy.api#documentation": "

The status of a connection.

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message generated if the action is not completed successfully.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of the Amazon Web Services Glue connection.

" + } + }, + "com.amazonaws.datazone#GluePropertiesPatch": { + "type": "structure", + "members": { + "glueConnectionInput": { + "target": "com.amazonaws.datazone#GlueConnectionPatch", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue properties patch of a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue properties patch of a connection.

" + } + }, + "com.amazonaws.datazone#GlueRunConfigurationInput": { + "type": "structure", + "members": { + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data\n source.

", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.

", + "smithy.api#required": {} + } + }, + "autoImportDataQualityResult": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data\n source run.

" + } + }, + "catalogName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The catalog name in the Amazon Web Services Glue run configuration.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the Amazon Web Services Glue data source.

" + } + }, + "com.amazonaws.datazone#GlueRunConfigurationOutput": { + "type": "structure", + "members": { + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data\n source.

", + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.\n

", + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" + } + }, + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data\n source.

", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.

", + "smithy.api#required": {} + } + }, + "autoImportDataQualityResult": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data\n source run.

" + } + }, + "catalogName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The catalog name in the Amazon Web Services Glue run configuration.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the Amazon Web Services Glue data source.

" + } + }, + "com.amazonaws.datazone#GlueSelfGrantStatusOutput": { + "type": "structure", + "members": { + "selfGrantStatusDetails": { + "target": "com.amazonaws.datazone#SelfGrantStatusDetails", + "traits": { + "smithy.api#documentation": "

The details for the self granting status for a Glue data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the self granting status.

" + } + }, + "com.amazonaws.datazone#GovernanceType": { + "type": "enum", + "members": { + "AWS_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_MANAGED" + } + }, + "USER_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_MANAGED" + } + } + } + }, + "com.amazonaws.datazone#GrantedEntity": { "type": "union", "members": { "listing": { @@ -17038,18 +19850,134 @@ } } }, - "com.amazonaws.datazone#IamUserProfileDetails": { - "type": "structure", + "com.amazonaws.datazone#HyperPodOrchestrator": { + "type": "enum", "members": { - "arn": { - "target": "smithy.api#String", + "EKS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ARN of an IAM user profile in Amazon DataZone.

" + "smithy.api#enumValue": "EKS" + } + }, + "SLURM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLURM" } } - }, - "traits": { - "smithy.api#documentation": "

The details of an IAM user profile in Amazon DataZone.

" + } + }, + "com.amazonaws.datazone#HyperPodPropertiesInput": { + "type": "structure", + "members": { + "clusterName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cluster name the hyper pod properties.

", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The hyper pod properties of a Amazon Web Services Glue properties patch.

" + } + }, + "com.amazonaws.datazone#HyperPodPropertiesOutput": { + "type": "structure", + "members": { + "clusterName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cluster name the hyper pod properties.

", + "smithy.api#required": {} + } + }, + "clusterArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cluster ARN of the hyper pod properties.

" + } + }, + "orchestrator": { + "target": "com.amazonaws.datazone#HyperPodOrchestrator", + "traits": { + "smithy.api#documentation": "

The orchestrator of the hyper pod properties.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The hyper pod properties of a Amazon Web Services Glue properties patch.

" + } + }, + "com.amazonaws.datazone#IamPropertiesInput": { + "type": "structure", + "members": { + "glueLineageSyncEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM properties of a connection.

" + } + }, + "com.amazonaws.datazone#IamPropertiesOutput": { + "type": "structure", + "members": { + "environmentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The environment ID of the connection.

" + } + }, + "glueLineageSyncEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM properties of a connection.

" + } + }, + "com.amazonaws.datazone#IamPropertiesPatch": { + "type": "structure", + "members": { + "glueLineageSyncEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM properties patch of a connection.

" + } + }, + "com.amazonaws.datazone#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" + } + }, + "com.amazonaws.datazone#IamUserProfileDetails": { + "type": "structure", + "members": { + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM user profile in Amazon DataZone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an IAM user profile in Amazon DataZone.

" } }, "com.amazonaws.datazone#Import": { @@ -17196,6 +20124,196 @@ } } }, + "com.amazonaws.datazone#JobRunDetails": { + "type": "union", + "members": { + "lineageRunDetails": { + "target": "com.amazonaws.datazone#LineageRunDetails", + "traits": { + "smithy.api#documentation": "

The data lineage details of a job run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a job run.

" + } + }, + "com.amazonaws.datazone#JobRunError": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job run error message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The job run error.

" + } + }, + "com.amazonaws.datazone#JobRunMode": { + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + } + } + }, + "com.amazonaws.datazone#JobRunStatus": { + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "PARTIALLY_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIALLY_SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "ABORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTED" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + }, + "CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELED" + } + } + } + }, + "com.amazonaws.datazone#JobRunSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#JobRunSummary" + } + }, + "com.amazonaws.datazone#JobRunSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID of the job run.

" + } + }, + "jobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job ID of a job run.

" + } + }, + "jobType": { + "target": "com.amazonaws.datazone#JobType", + "traits": { + "smithy.api#documentation": "

The job type of a job run.

" + } + }, + "runId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The run ID of a job run.

" + } + }, + "runMode": { + "target": "com.amazonaws.datazone#JobRunMode", + "traits": { + "smithy.api#documentation": "

The run mode of a job run.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#JobRunStatus", + "traits": { + "smithy.api#documentation": "

The status of a job run.

" + } + }, + "error": { + "target": "com.amazonaws.datazone#JobRunError", + "traits": { + "smithy.api#documentation": "

The error of a job run.

" + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which job run was created.

" + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of a job run.

" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of a job run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The job run summary.

" + } + }, + "com.amazonaws.datazone#JobType": { + "type": "enum", + "members": { + "LINEAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAGE" + } + } + } + }, "com.amazonaws.datazone#KmsKeyArn": { "type": "string", "traits": { @@ -17307,34 +20425,183 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#LineageNodeId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" - } + "com.amazonaws.datazone#LineageEventErrorMessage": { + "type": "string" }, - "com.amazonaws.datazone#LineageNodeIdentifier": { + "com.amazonaws.datazone#LineageEventIdentifier": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 2086 - } + "smithy.api#pattern": "^[a-z0-9]{14}$" } }, - "com.amazonaws.datazone#LineageNodeReference": { - "type": "structure", + "com.amazonaws.datazone#LineageEventProcessingStatus": { + "type": "enum", "members": { - "id": { - "target": "com.amazonaws.datazone#LineageNodeId", + "REQUESTED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ID of the data lineage node.

" + "smithy.api#enumValue": "REQUESTED" } }, - "eventTimestamp": { - "target": "smithy.api#Timestamp", + "PROCESSING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The event timestamp of the data lineage node.

" + "smithy.api#enumValue": "PROCESSING" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.datazone#LineageEventSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#LineageEventSummary" + } + }, + "com.amazonaws.datazone#LineageEventSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#LineageEventIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the data lineage event.

" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID of the lineage event.

" + } + }, + "processingStatus": { + "target": "com.amazonaws.datazone#LineageEventProcessingStatus", + "traits": { + "smithy.api#documentation": "

The processing status of the data lineage event.

" + } + }, + "eventTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time of the data lineage event.

" + } + }, + "eventSummary": { + "target": "com.amazonaws.datazone#EventSummary", + "traits": { + "smithy.api#documentation": "

The summary of the data lineate event.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the data lineage event.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which data lineage event was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data lineage event summary.

" + } + }, + "com.amazonaws.datazone#LineageImportStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PARTIALLY_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIALLY_SUCCEEDED" + } + } + } + }, + "com.amazonaws.datazone#LineageInfo": { + "type": "structure", + "members": { + "eventId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The data lineage event ID.

" + } + }, + "eventStatus": { + "target": "com.amazonaws.datazone#LineageEventProcessingStatus", + "traits": { + "smithy.api#documentation": "

The data lineage event status.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#LineageEventErrorMessage", + "traits": { + "smithy.api#documentation": "

The data lineage error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data lineage information.

" + } + }, + "com.amazonaws.datazone#LineageNodeId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#LineageNodeIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2086 + } + } + }, + "com.amazonaws.datazone#LineageNodeReference": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#LineageNodeId", + "traits": { + "smithy.api#documentation": "

The ID of the data lineage node.

" + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The event timestamp of the data lineage node.

" } } }, @@ -17507,6 +20774,73 @@ "smithy.api#documentation": "

The details of a data lineage node type.

" } }, + "com.amazonaws.datazone#LineageRunDetails": { + "type": "structure", + "members": { + "sqlQueryRunDetails": { + "target": "com.amazonaws.datazone#LineageSqlQueryRunDetails", + "traits": { + "smithy.api#documentation": "

The SQL query run details of a data lineage run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data lineage run details.

" + } + }, + "com.amazonaws.datazone#LineageSqlQueryRunDetails": { + "type": "structure", + "members": { + "queryStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The query start time in the SQL query run details of a data lineage run.

" + } + }, + "queryEndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The query end time in the SQL query run details of a data lineage run.

" + } + }, + "totalQueriesProcessed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total queries processed in the SQL query run details of a data lineage run.

" + } + }, + "numQueriesFailed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of queries that failed in the SQL query run details of a data lineage run.

" + } + }, + "errorMessages": { + "target": "com.amazonaws.datazone#FailedQueryProcessingErrorMessages", + "traits": { + "smithy.api#documentation": "

The error message of the SQL query run details of a data lineage run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SQL query run details of a data lineage run.

" + } + }, + "com.amazonaws.datazone#LineageSyncSchedule": { + "type": "structure", + "members": { + "schedule": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The lineage sync schedule.

", + "smithy.api#pattern": "^cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) ([-?*,/\\dLW]){1,83} ([-*,/\\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\\dL]|[a-zA-Z]{3}){1,13} ([^\\)]+)\\)$" + } + } + }, + "traits": { + "smithy.api#documentation": "

The lineage sync schedule.

" + } + }, "com.amazonaws.datazone#ListAssetFilters": { "type": "operation", "input": { @@ -17708,13 +21042,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListDataProductRevisions": { + "com.amazonaws.datazone#ListConnections": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListDataProductRevisionsInput" + "target": "com.amazonaws.datazone#ListConnectionsInput" }, "output": { - "target": "com.amazonaws.datazone#ListDataProductRevisionsOutput" + "target": "com.amazonaws.datazone#ListConnectionsOutput" }, "errors": [ { @@ -17723,9 +21057,6 @@ { "target": "com.amazonaws.datazone#InternalServerException" }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" - }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -17734,11 +21065,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists data product revisions.

", + "smithy.api#documentation": "

Lists connections. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}/revisions" + "uri": "/v2/domains/{domainIdentifier}/connections" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -17749,21 +21080,13 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListDataProductRevisionsInput": { + "com.amazonaws.datazone#ListConnectionsInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain of the data product revisions that you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "identifier": { - "target": "com.amazonaws.datazone#DataProductId", - "traits": { - "smithy.api#documentation": "

The ID of the data product revision.

", + "smithy.api#documentation": "

The ID of the domain where you want to list connections.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17771,36 +21094,79 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of asset filters to return in a single call to\n ListDataProductRevisions. When the number of data product revisions to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

", + "smithy.api#documentation": "

The maximum number of connections to return in a single call to ListConnections. When\n the number of connections to be listed is greater than the value of MaxResults, the\n response contains a NextToken value that you can use in a subsequent call to\n ListConnections to list the next set of connections.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data product revisions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

", + "smithy.api#documentation": "

When the number of connections is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of connections, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListConnections to list the next set of\n connections.

", "smithy.api#httpQuery": "nextToken" } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortFieldConnection", + "traits": { + "smithy.api#documentation": "

Specifies how you want to sort the listed connections.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "

Specifies the sort order for the listed connections.

", + "smithy.api#httpQuery": "sortOrder" + } + }, + "name": { + "target": "com.amazonaws.datazone#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection.

", + "smithy.api#httpQuery": "name" + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "

The ID of the environment where you want to list connections.

", + "smithy.api#httpQuery": "environmentIdentifier" + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the project where you want to list connections.

", + "smithy.api#httpQuery": "projectIdentifier", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of connection.

", + "smithy.api#httpQuery": "type" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.datazone#ListDataProductRevisionsOutput": { + "com.amazonaws.datazone#ListConnectionsOutput": { "type": "structure", "members": { "items": { - "target": "com.amazonaws.datazone#DataProductRevisions", + "target": "com.amazonaws.datazone#ConnectionSummaries", "traits": { - "smithy.api#documentation": "

The results of the ListDataProductRevisions action.

", + "smithy.api#documentation": "

The results of the ListConnections action.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data product revisions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

" + "smithy.api#documentation": "

When the number of connections is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of connections, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListConnections to list the next set of\n connections.

" } } }, @@ -17808,30 +21174,24 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListDataSourceRunActivities": { + "com.amazonaws.datazone#ListDataProductRevisions": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListDataSourceRunActivitiesInput" + "target": "com.amazonaws.datazone#ListDataProductRevisionsInput" }, "output": { - "target": "com.amazonaws.datazone#ListDataSourceRunActivitiesOutput" + "target": "com.amazonaws.datazone#ListDataProductRevisionsOutput" }, "errors": [ { "target": "com.amazonaws.datazone#AccessDeniedException" }, - { - "target": "com.amazonaws.datazone#ConflictException" - }, { "target": "com.amazonaws.datazone#InternalServerException" }, { "target": "com.amazonaws.datazone#ResourceNotFoundException" }, - { - "target": "com.amazonaws.datazone#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -17840,11 +21200,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists data source run activities.

", + "smithy.api#documentation": "

Lists data product revisions.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/data-source-runs/{identifier}/activities" + "uri": "/v2/domains/{domainIdentifier}/data-products/{identifier}/revisions" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -17855,26 +21215,132 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListDataSourceRunActivitiesInput": { + "com.amazonaws.datazone#ListDataProductRevisionsInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to list data source run\n activities.

", + "smithy.api#documentation": "

The ID of the domain of the data product revisions that you want to list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "identifier": { - "target": "com.amazonaws.datazone#DataSourceRunId", + "target": "com.amazonaws.datazone#DataProductId", "traits": { - "smithy.api#documentation": "

The identifier of the data source run.

", + "smithy.api#documentation": "

The ID of the data product revision.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "status": { + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of asset filters to return in a single call to\n ListDataProductRevisions. When the number of data product revisions to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data product revisions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListDataProductRevisionsOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#DataProductRevisions", + "traits": { + "smithy.api#documentation": "

The results of the ListDataProductRevisions action.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data product revisions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListDataSourceRunActivities": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListDataSourceRunActivitiesInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListDataSourceRunActivitiesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists data source run activities.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/data-source-runs/{identifier}/activities" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListDataSourceRunActivitiesInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to list data source run\n activities.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DataSourceRunId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { "target": "com.amazonaws.datazone#DataAssetActivityStatus", "traits": { "smithy.api#documentation": "

The status of the data source run.

", @@ -18107,6 +21573,13 @@ "smithy.api#httpQuery": "environmentIdentifier" } }, + "connectionIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the connection.

", + "smithy.api#httpQuery": "connectionIdentifier" + } + }, "type": { "target": "com.amazonaws.datazone#DataSourceType", "traits": { @@ -19042,13 +22515,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListLineageNodeHistory": { + "com.amazonaws.datazone#ListJobRuns": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListLineageNodeHistoryInput" + "target": "com.amazonaws.datazone#ListJobRunsInput" }, "output": { - "target": "com.amazonaws.datazone#ListLineageNodeHistoryOutput" + "target": "com.amazonaws.datazone#ListJobRunsOutput" }, "errors": [ { @@ -19068,80 +22541,67 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the history of the specified data lineage node.

", + "smithy.api#documentation": "

Lists job runs.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/lineage/nodes/{identifier}/history" + "uri": "/v2/domains/{domainIdentifier}/jobs/{jobIdentifier}/runs" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "nodes" + "items": "items" }, "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListLineageNodeHistoryInput": { + "com.amazonaws.datazone#ListJobRunsInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain where you want to list the history of the specified data lineage\n node.

", + "smithy.api#documentation": "

The ID of the domain where you want to list job runs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.datazone#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of history items to return in a single call to\n ListLineageNodeHistory. When the number of memberships to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListLineageNodeHistory to list the next set of items.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.datazone#PaginationToken", - "traits": { - "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "identifier": { - "target": "com.amazonaws.datazone#LineageNodeIdentifier", + "jobIdentifier": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the data lineage node whose history you want to list.

", + "smithy.api#documentation": "

The ID of the job run.

", "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$", "smithy.api#required": {} } }, - "direction": { - "target": "com.amazonaws.datazone#EdgeDirection", + "status": { + "target": "com.amazonaws.datazone#JobRunStatus", "traits": { - "smithy.api#documentation": "

The direction of the data lineage node refers to the lineage node having neighbors in\n that direction. For example, if direction is UPSTREAM, the\n ListLineageNodeHistory API responds with historical versions with upstream\n neighbors only.

", - "smithy.api#httpQuery": "direction" + "smithy.api#documentation": "

The status of a job run.

", + "smithy.api#httpQuery": "status" } }, - "eventTimestampGTE": { - "target": "smithy.api#Timestamp", + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", "traits": { - "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time after\n the event timestamp.

", - "smithy.api#httpQuery": "timestampGTE" + "smithy.api#documentation": "

Specifies the order in which job runs are to be sorted.

", + "smithy.api#httpQuery": "sortOrder" } }, - "eventTimestampLTE": { - "target": "smithy.api#Timestamp", + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time prior\n of the event timestamp.

", - "smithy.api#httpQuery": "timestampLTE" + "smithy.api#documentation": "

When the number of job runs is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of job runs, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListJobRuns to list the next set of job\n runs.

", + "smithy.api#httpQuery": "nextToken" } }, - "sortOrder": { - "target": "com.amazonaws.datazone#SortOrder", + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The order by which you want data lineage node history to be sorted.

", - "smithy.api#httpQuery": "sortOrder" + "smithy.api#documentation": "

The maximum number of job runs to return in a single call to ListJobRuns. When the\n number of job runs to be listed is greater than the value of MaxResults, the response\n contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the\n next set of job runs.

", + "smithy.api#httpQuery": "maxResults" } } }, @@ -19149,19 +22609,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#ListLineageNodeHistoryOutput": { + "com.amazonaws.datazone#ListJobRunsOutput": { "type": "structure", "members": { - "nodes": { - "target": "com.amazonaws.datazone#LineageNodeSummaries", + "items": { + "target": "com.amazonaws.datazone#JobRunSummaries", "traits": { - "smithy.api#documentation": "

The nodes returned by the ListLineageNodeHistory action.

" + "smithy.api#documentation": "

The results of the ListJobRuns action.

" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.

" + "smithy.api#documentation": "

When the number of job runs is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of job runs, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListJobRuns to list the next set of job\n runs.

" } } }, @@ -19169,13 +22629,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListMetadataGenerationRuns": { + "com.amazonaws.datazone#ListLineageEvents": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListMetadataGenerationRunsInput" + "target": "com.amazonaws.datazone#ListLineageEventsInput" }, "output": { - "target": "com.amazonaws.datazone#ListMetadataGenerationRunsOutput" + "target": "com.amazonaws.datazone#ListLineageEventsOutput" }, "errors": [ { @@ -19184,9 +22644,6 @@ { "target": "com.amazonaws.datazone#InternalServerException" }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" - }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -19195,11 +22652,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all metadata generation runs.

", + "smithy.api#documentation": "

Lists lineage events.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/metadata-generation-runs" + "uri": "/v2/domains/{domainIdentifier}/lineage/events" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -19210,43 +22667,57 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListMetadataGenerationRunsInput": { + "com.amazonaws.datazone#ListLineageEventsInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain where you want to list metadata generation\n runs.

", + "smithy.api#documentation": "

The ID of the domain where you want to list lineage events.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.datazone#MetadataGenerationRunStatus", + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The status of the metadata generation runs.

", - "smithy.api#httpQuery": "status" + "smithy.api#documentation": "

The maximum number of lineage events to return in a single call to ListLineageEvents.\n When the number of lineage events to be listed is greater than the value of MaxResults, the\n response contains a NextToken value that you can use in a subsequent call to\n ListLineageEvents to list the next set of lineage events.

", + "smithy.api#httpQuery": "maxResults" } }, - "type": { - "target": "com.amazonaws.datazone#MetadataGenerationRunType", + "timestampAfter": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The type of the metadata generation runs.

", - "smithy.api#httpQuery": "type" + "smithy.api#documentation": "

The after timestamp of a lineage event.

", + "smithy.api#httpQuery": "timestampAfter" } }, - "nextToken": { - "target": "com.amazonaws.datazone#PaginationToken", + "timestampBefore": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than\n the number of metadata generation runs, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a subsequent call to\n ListMetadataGenerationRuns to list the next set of revisions.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The before timestamp of a lineage event.

", + "smithy.api#httpQuery": "timestampBefore" } }, - "maxResults": { - "target": "com.amazonaws.datazone#MaxResults", + "processingStatus": { + "target": "com.amazonaws.datazone#LineageEventProcessingStatus", "traits": { - "smithy.api#documentation": "

The maximum number of metadata generation runs to return in a single call to\n ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is\n greater than the value of MaxResults, the response contains a NextToken value that you can\n use in a subsequent call to ListMetadataGenerationRuns to list the next set of\n revisions.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The processing status of a lineage event.

", + "smithy.api#httpQuery": "processingStatus" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order of the lineage events.

", + "smithy.api#httpQuery": "sortOrder" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of lineage events is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of lineage events, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListLineageEvents to list the next set\n of lineage events.

", + "smithy.api#httpQuery": "nextToken" } } }, @@ -19254,19 +22725,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#ListMetadataGenerationRunsOutput": { + "com.amazonaws.datazone#ListLineageEventsOutput": { "type": "structure", "members": { "items": { - "target": "com.amazonaws.datazone#MetadataGenerationRuns", + "target": "com.amazonaws.datazone#LineageEventSummaries", "traits": { - "smithy.api#documentation": "

The results of the ListMetadataGenerationRuns action.

" + "smithy.api#documentation": "

The results of the ListLineageEvents action.

" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than\n the number of metadata generation runs, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a subsequent call to\n ListMetadataGenerationRuns to list the next set of revisions.

" + "smithy.api#documentation": "

When the number of lineage events is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of lineage events, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListLineageEvents to list the next set\n of lineage events.

" } } }, @@ -19274,13 +22745,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListNotifications": { + "com.amazonaws.datazone#ListLineageNodeHistory": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListNotificationsInput" + "target": "com.amazonaws.datazone#ListLineageNodeHistoryInput" }, "output": { - "target": "com.amazonaws.datazone#ListNotificationsOutput" + "target": "com.amazonaws.datazone#ListLineageNodeHistoryOutput" }, "errors": [ { @@ -19292,53 +22763,285 @@ { "target": "com.amazonaws.datazone#ResourceNotFoundException" }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, { "target": "com.amazonaws.datazone#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Lists all Amazon DataZone notifications.

", + "smithy.api#documentation": "

Lists the history of the specified data lineage node.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/notifications" + "uri": "/v2/domains/{domainIdentifier}/lineage/nodes/{identifier}/history" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "notifications" + "items": "nodes" }, "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListNotificationsInput": { + "com.amazonaws.datazone#ListLineageNodeHistoryInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain.

", + "smithy.api#documentation": "

The ID of the domain where you want to list the history of the specified data lineage\n node.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.datazone#NotificationType", + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The type of notifications.

", - "smithy.api#httpQuery": "type", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of history items to return in a single call to\n ListLineageNodeHistory. When the number of memberships to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListLineageNodeHistory to list the next set of items.

", + "smithy.api#httpQuery": "maxResults" } }, - "afterTimestamp": { - "target": "smithy.api#Timestamp", + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

The time after which you want to list notifications.

", - "smithy.api#httpQuery": "afterTimestamp" + "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.

", + "smithy.api#httpQuery": "nextToken" } }, - "beforeTimestamp": { + "identifier": { + "target": "com.amazonaws.datazone#LineageNodeIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the data lineage node whose history you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "direction": { + "target": "com.amazonaws.datazone#EdgeDirection", + "traits": { + "smithy.api#documentation": "

The direction of the data lineage node refers to the lineage node having neighbors in\n that direction. For example, if direction is UPSTREAM, the\n ListLineageNodeHistory API responds with historical versions with upstream\n neighbors only.

", + "smithy.api#httpQuery": "direction" + } + }, + "eventTimestampGTE": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time after\n the event timestamp.

", + "smithy.api#httpQuery": "timestampGTE" + } + }, + "eventTimestampLTE": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time prior\n of the event timestamp.

", + "smithy.api#httpQuery": "timestampLTE" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "

The order by which you want data lineage node history to be sorted.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListLineageNodeHistoryOutput": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.datazone#LineageNodeSummaries", + "traits": { + "smithy.api#documentation": "

The nodes returned by the ListLineageNodeHistory action.

" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListMetadataGenerationRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListMetadataGenerationRunsInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListMetadataGenerationRunsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all metadata generation runs.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/metadata-generation-runs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListMetadataGenerationRunsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain where you want to list metadata generation\n runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#MetadataGenerationRunStatus", + "traits": { + "smithy.api#documentation": "

The status of the metadata generation runs.

", + "smithy.api#httpQuery": "status" + } + }, + "type": { + "target": "com.amazonaws.datazone#MetadataGenerationRunType", + "traits": { + "smithy.api#documentation": "

The type of the metadata generation runs.

", + "smithy.api#httpQuery": "type" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than\n the number of metadata generation runs, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a subsequent call to\n ListMetadataGenerationRuns to list the next set of revisions.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of metadata generation runs to return in a single call to\n ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is\n greater than the value of MaxResults, the response contains a NextToken value that you can\n use in a subsequent call to ListMetadataGenerationRuns to list the next set of\n revisions.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListMetadataGenerationRunsOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#MetadataGenerationRuns", + "traits": { + "smithy.api#documentation": "

The results of the ListMetadataGenerationRuns action.

" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than\n the number of metadata generation runs, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a subsequent call to\n ListMetadataGenerationRuns to list the next set of revisions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListNotificationsInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListNotificationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Amazon DataZone notifications.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/notifications" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "notifications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListNotificationsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#NotificationType", + "traits": { + "smithy.api#documentation": "

The type of notifications.

", + "smithy.api#httpQuery": "type", + "smithy.api#required": {} + } + }, + "afterTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time after which you want to list notifications.

", + "smithy.api#httpQuery": "afterTimestamp" + } + }, + "beforeTimestamp": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time before which you want to list notifications.

", @@ -19628,13 +23331,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListProjects": { + "com.amazonaws.datazone#ListProjectProfiles": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListProjectsInput" + "target": "com.amazonaws.datazone#ListProjectProfilesInput" }, "output": { - "target": "com.amazonaws.datazone#ListProjectsOutput" + "target": "com.amazonaws.datazone#ListProjectProfilesOutput" }, "errors": [ { @@ -19651,11 +23354,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists Amazon DataZone projects.

", + "smithy.api#documentation": "

Lists project profiles.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/projects" + "uri": "/v2/domains/{domainIdentifier}/project-profiles" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -19666,35 +23369,144 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListProjectsInput": { + "com.amazonaws.datazone#ListProjectProfilesInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain.

", + "smithy.api#documentation": "

The ID of the domain where you want to list project profiles.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "userIdentifier": { - "target": "smithy.api#String", + "name": { + "target": "com.amazonaws.datazone#ProjectProfileName", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone user.

", - "smithy.api#httpQuery": "userIdentifier" + "smithy.api#documentation": "

The name of a project profile.

", + "smithy.api#httpQuery": "name" } }, - "groupIdentifier": { - "target": "smithy.api#String", + "sortBy": { + "target": "com.amazonaws.datazone#SortFieldProject", "traits": { - "smithy.api#documentation": "

The identifier of a group.

", - "smithy.api#httpQuery": "groupIdentifier" + "smithy.api#documentation": "

Specifies by what to sort project profiles.

", + "smithy.api#httpQuery": "sortBy" } }, - "name": { - "target": "com.amazonaws.datazone#ProjectName", + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", "traits": { - "smithy.api#documentation": "

The name of the project.

", + "smithy.api#documentation": "

Specifies the sort order of the project profiles.

", + "smithy.api#httpQuery": "sortOrder" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of project profiles is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of project profiles, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListProjectProfiles to list the next\n set of project profiles.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of project profiles to return in a single call to\n ListProjectProfiles. When the number of project profiles to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListProjectProfiles to list the next set of project profiles.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListProjectProfilesOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#ProjectProfileSummaries", + "traits": { + "smithy.api#documentation": "

The results of the ListProjectProfiles action.

" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of project profiles is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of project profiles, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListProjectProfiles to list the next\n set of project profiles.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListProjectsInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListProjectsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Amazon DataZone projects.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/projects" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListProjectsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon DataZone user.

", + "smithy.api#httpQuery": "userIdentifier" + } + }, + "groupIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of a group.

", + "smithy.api#httpQuery": "groupIdentifier" + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project.

", "smithy.api#httpQuery": "name" } }, @@ -20903,6 +24715,30 @@ "traits": { "smithy.api#enumValue": "CREATE_ENVIRONMENT" } + }, + "CREATE_ENVIRONMENT_FROM_BLUEPRINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ENVIRONMENT_FROM_BLUEPRINT" + } + }, + "CREATE_PROJECT_FROM_PROJECT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_PROJECT_FROM_PROJECT_PROFILE" + } + } + } + }, + "com.amazonaws.datazone#MatchCriteria": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 } } }, @@ -21297,6 +25133,32 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#NameIdentifier": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name in the name identifier.

" + } + }, + "namespace": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The namespace in the name identifier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The name identifier.

" + } + }, + "com.amazonaws.datazone#NameIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#NameIdentifier" + } + }, "com.amazonaws.datazone#NotEqualToExpression": { "type": "structure", "members": { @@ -21549,125 +25411,338 @@ "target": "com.amazonaws.datazone#NotificationOutput" } }, - "com.amazonaws.datazone#OverrideDomainUnitOwnersPolicyGrantDetail": { + "com.amazonaws.datazone#OAuth2ClientApplication": { "type": "structure", "members": { - "includeChildDomainUnits": { - "target": "smithy.api#Boolean", + "userManagedClientApplicationClientId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies whether the policy is inherited by child domain units.

" + "smithy.api#documentation": "

The user managed client application client ID in the OAuth2Client application.

", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" } - } - }, - "traits": { - "smithy.api#documentation": "

The grant details of the override domain unit owners policy.

" - } - }, - "com.amazonaws.datazone#OverrideProjectOwnersPolicyGrantDetail": { - "type": "structure", - "members": { - "includeChildDomainUnits": { - "target": "smithy.api#Boolean", + }, + "aWSManagedClientApplicationReference": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies whether the policy is inherited by child domain units.

" + "smithy.api#documentation": "

The Amazon Web Services managed client application reference in the OAuth2Client application.

", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" } } }, "traits": { - "smithy.api#documentation": "

The details of the override project owners policy grant.

" + "smithy.api#documentation": "

The OAuth2Client application.

" } }, - "com.amazonaws.datazone#OwnerGroupProperties": { - "type": "structure", + "com.amazonaws.datazone#OAuth2GrantType": { + "type": "enum", "members": { - "groupIdentifier": { - "target": "com.amazonaws.datazone#GroupIdentifier", + "AUTHORIZATION_CODE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ID of the domain unit owners group.

", - "smithy.api#required": {} + "smithy.api#enumValue": "AUTHORIZATION_CODE" + } + }, + "CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CREDENTIALS" + } + }, + "JWT_BEARER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JWT_BEARER" } } - }, - "traits": { - "smithy.api#documentation": "

The properties of the domain unit owners group.

" } }, - "com.amazonaws.datazone#OwnerGroupPropertiesOutput": { + "com.amazonaws.datazone#OAuth2Properties": { "type": "structure", "members": { - "groupId": { - "target": "smithy.api#String", + "oAuth2GrantType": { + "target": "com.amazonaws.datazone#OAuth2GrantType", "traits": { - "smithy.api#documentation": "

The ID of the domain unit owners group.

" + "smithy.api#documentation": "

The OAuth2 grant type of the OAuth2 properties.

" } - } - }, - "traits": { - "smithy.api#documentation": "

The properties of the domain unit owners group.

" - } - }, - "com.amazonaws.datazone#OwnerProperties": { - "type": "union", - "members": { - "user": { - "target": "com.amazonaws.datazone#OwnerUserProperties", + }, + "oAuth2ClientApplication": { + "target": "com.amazonaws.datazone#OAuth2ClientApplication", "traits": { - "smithy.api#documentation": "

Specifies that the domain unit owner is a user.

" + "smithy.api#documentation": "

The OAuth2 client application of the OAuth2 properties.

" } }, - "group": { - "target": "com.amazonaws.datazone#OwnerGroupProperties", + "tokenUrl": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies that the domain unit owner is a group.

" + "smithy.api#documentation": "

The OAuth2 token URL of the OAuth2 properties.

", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" } - } - }, - "traits": { - "smithy.api#documentation": "

The properties of a domain unit's owner.

" - } - }, - "com.amazonaws.datazone#OwnerPropertiesOutput": { - "type": "union", - "members": { - "user": { - "target": "com.amazonaws.datazone#OwnerUserPropertiesOutput", + }, + "tokenUrlParametersMap": { + "target": "com.amazonaws.datazone#TokenUrlParametersMap", "traits": { - "smithy.api#documentation": "

Specifies that the domain unit owner is a user.

" + "smithy.api#documentation": "

The OAuth2 token URL parameter map of the OAuth2 properties.

" } }, - "group": { - "target": "com.amazonaws.datazone#OwnerGroupPropertiesOutput", + "authorizationCodeProperties": { + "target": "com.amazonaws.datazone#AuthorizationCodeProperties", "traits": { - "smithy.api#documentation": "

Specifies that the domain unit owner is a group.

" + "smithy.api#documentation": "

The authorization code properties of the OAuth2 properties.

" + } + }, + "oAuth2Credentials": { + "target": "com.amazonaws.datazone#GlueOAuth2Credentials", + "traits": { + "smithy.api#documentation": "

The OAuth2 credentials of the OAuth2 properties.

" } } }, "traits": { - "smithy.api#documentation": "

The ID of the domain unit owners group.

" + "smithy.api#documentation": "

The OAuth2 properties.

" } }, - "com.amazonaws.datazone#OwnerUserProperties": { + "com.amazonaws.datazone#OpenLineageRunEventSummary": { "type": "structure", "members": { - "userIdentifier": { - "target": "com.amazonaws.datazone#UserIdentifier", + "eventType": { + "target": "com.amazonaws.datazone#OpenLineageRunState", "traits": { - "smithy.api#documentation": "

The ID of the owner user.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The event type of the open lineage run event summary.

" + } + }, + "runId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The runID of the open lineage run event summary.

" + } + }, + "job": { + "target": "com.amazonaws.datazone#NameIdentifier", + "traits": { + "smithy.api#documentation": "

The job of the open lineage run event summary.

" + } + }, + "inputs": { + "target": "com.amazonaws.datazone#NameIdentifiers", + "traits": { + "smithy.api#documentation": "

The inputs of the open lineage run event summary.

" + } + }, + "outputs": { + "target": "com.amazonaws.datazone#NameIdentifiers", + "traits": { + "smithy.api#documentation": "

The outputs of the open lineage run event summary.

" } } }, "traits": { - "smithy.api#documentation": "

The properties of the owner user.

" + "smithy.api#documentation": "

The open lineage run event summary.

" } }, - "com.amazonaws.datazone#OwnerUserPropertiesOutput": { - "type": "structure", + "com.amazonaws.datazone#OpenLineageRunState": { + "type": "enum", "members": { - "userId": { - "target": "smithy.api#String", + "START": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ID of the owner user.

" + "smithy.api#enumValue": "START" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "ABORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORT" + } + }, + "FAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.datazone#OverallDeploymentStatus": { + "type": "enum", + "members": { + "PENDING_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DEPLOYMENT" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED_VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_VALIDATION" + } + }, + "FAILED_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_DEPLOYMENT" + } + } + } + }, + "com.amazonaws.datazone#OverrideDomainUnitOwnersPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy is inherited by child domain units.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The grant details of the override domain unit owners policy.

" + } + }, + "com.amazonaws.datazone#OverrideProjectOwnersPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy is inherited by child domain units.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the override project owners policy grant.

" + } + }, + "com.amazonaws.datazone#OwnerGroupProperties": { + "type": "structure", + "members": { + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit owners group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of the domain unit owners group.

" + } + }, + "com.amazonaws.datazone#OwnerGroupPropertiesOutput": { + "type": "structure", + "members": { + "groupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit owners group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of the domain unit owners group.

" + } + }, + "com.amazonaws.datazone#OwnerProperties": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#OwnerUserProperties", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a user.

" + } + }, + "group": { + "target": "com.amazonaws.datazone#OwnerGroupProperties", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a domain unit's owner.

" + } + }, + "com.amazonaws.datazone#OwnerPropertiesOutput": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#OwnerUserPropertiesOutput", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a user.

" + } + }, + "group": { + "target": "com.amazonaws.datazone#OwnerGroupPropertiesOutput", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ID of the domain unit owners group.

" + } + }, + "com.amazonaws.datazone#OwnerUserProperties": { + "type": "structure", + "members": { + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the owner user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of the owner user.

" + } + }, + "com.amazonaws.datazone#OwnerUserPropertiesOutput": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the owner user.

" } } }, @@ -21684,6 +25759,122 @@ } } }, + "com.amazonaws.datazone#ParameterStorePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.datazone#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#PhysicalConnectionRequirements": { + "type": "structure", + "members": { + "subnetId": { + "target": "com.amazonaws.datazone#SubnetId", + "traits": { + "smithy.api#documentation": "

The subnet ID of the physical connection requirements of a connection.

" + } + }, + "subnetIdList": { + "target": "com.amazonaws.datazone#SubnetIdList", + "traits": { + "smithy.api#documentation": "

The subnet ID list of the physical connection requirements of a connection.

" + } + }, + "securityGroupIdList": { + "target": "com.amazonaws.datazone#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The group ID list of the physical connection requirements of a connection.

" + } + }, + "availabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The availability zone of the physical connection requirements of a connection.

", + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

Physical connection requirements of a connection.

" + } + }, + "com.amazonaws.datazone#PhysicalEndpoint": { + "type": "structure", + "members": { + "awsLocation": { + "target": "com.amazonaws.datazone#AwsLocation", + "traits": { + "smithy.api#documentation": "

The location of a connection.

" + } + }, + "glueConnectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue connection name.

" + } + }, + "glueConnection": { + "target": "com.amazonaws.datazone#GlueConnection", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue connection.

" + } + }, + "host": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The host in the physical endpoints of a connection.

" + } + }, + "port": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The port in the physical endpoints of a connection.

" + } + }, + "protocol": { + "target": "com.amazonaws.datazone#Protocol", + "traits": { + "smithy.api#documentation": "

The protocol in the physical endpoints of a connection.

" + } + }, + "stage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The stage in the physical endpoints of a connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The physical endpoints of a connection.

" + } + }, + "com.amazonaws.datazone#PhysicalEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#PhysicalEndpoint" + } + }, + "com.amazonaws.datazone#PolicyArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:iam::(aws|\\d{12}):policy/[\\w+=,.@-]*$" + } + }, "com.amazonaws.datazone#PolicyGrantDetail": { "type": "union", "members": { @@ -21752,6 +25943,15 @@ "traits": { "smithy.api#documentation": "

Specifies that this is a create environment policy.

" } + }, + "createEnvironmentFromBlueprint": { + "target": "com.amazonaws.datazone#Unit" + }, + "createProjectFromProjectProfile": { + "target": "com.amazonaws.datazone#CreateProjectFromProjectProfilePolicyGrantDetail", + "traits": { + "smithy.api#documentation": "

Specifies whether to create a project from project profile.

" + } } }, "traits": { @@ -21892,7 +26092,7 @@ "target": "com.amazonaws.datazone#ClientToken", "traits": { "smithy.api#documentation": "

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

", - "smithy.api#httpQuery": "clientToken", + "smithy.api#httpHeader": "Client-Token", "smithy.api#idempotencyToken": {} } } @@ -21903,7 +26103,20 @@ }, "com.amazonaws.datazone#PostLineageEventOutput": { "type": "structure", - "members": {}, + "members": { + "id": { + "target": "com.amazonaws.datazone#LineageEventIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the lineage event.

" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain.

" + } + } + }, "traits": { "smithy.api#output": {} } @@ -22182,6 +26395,103 @@ "smithy.api#documentation": "

The project policy grant principal.

" } }, + "com.amazonaws.datazone#ProjectProfileId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#ProjectProfileList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.datazone#ProjectProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#ProjectProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ProjectProfileSummary" + } + }, + "com.amazonaws.datazone#ProjectProfileSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID of the project profile.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectProfileName", + "traits": { + "smithy.api#documentation": "

The name of a project profile.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the project profile.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#Status", + "traits": { + "smithy.api#documentation": "

The status of a project profile.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the project profile.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the project profile was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which a project profile was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The domain unit ID of the project profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of a project profile.

" + } + }, "com.amazonaws.datazone#ProjectStatus": { "type": "enum", "members": { @@ -22306,6 +26616,74 @@ "smithy.api#documentation": "

Specifies projects in which the rule is created.

" } }, + "com.amazonaws.datazone#PropertyMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + } + }, + "com.amazonaws.datazone#Protocol": { + "type": "enum", + "members": { + "ATHENA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATHENA" + } + }, + "GLUE_INTERACTIVE_SESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLUE_INTERACTIVE_SESSION" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "JDBC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JDBC" + } + }, + "LIVY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVY" + } + }, + "ODBC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ODBC" + } + }, + "PRISM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRISM" + } + } + } + }, "com.amazonaws.datazone#ProvisioningConfiguration": { "type": "union", "members": { @@ -22409,6 +26787,12 @@ "smithy.api#documentation": "

The ARN of the manage access role.

" } }, + "environmentRolePermissionBoundary": { + "target": "com.amazonaws.datazone#PolicyArn", + "traits": { + "smithy.api#documentation": "

The environment role permissions boundary.

" + } + }, "enabledRegions": { "target": "com.amazonaws.datazone#EnabledRegionList", "traits": { @@ -22457,6 +26841,12 @@ "smithy.api#documentation": "

The ARN of the provisioning role.

" } }, + "environmentRolePermissionBoundary": { + "target": "com.amazonaws.datazone#PolicyArn", + "traits": { + "smithy.api#documentation": "

The environment role permissions boundary.

" + } + }, "manageAccessRoleArn": { "target": "com.amazonaws.datazone#RoleArn", "traits": { @@ -22554,130 +26944,351 @@ "smithy.api#documentation": "

The details of the credentials required to access an Amazon Redshift cluster.

" } }, - "com.amazonaws.datazone#RedshiftRunConfigurationInput": { - "type": "structure", + "com.amazonaws.datazone#RedshiftCredentials": { + "type": "union", "members": { - "dataAccessRole": { + "secretArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data\n source.

", - "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + "smithy.api#documentation": "

The secret ARN of the Amazon Redshift credentials of a connection.

", + "smithy.api#pattern": "^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:secret:.*$" } }, - "relationalFilterConfigurations": { - "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "usernamePassword": { + "target": "com.amazonaws.datazone#UsernamePassword", "traits": { - "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The username and password of the Amazon Redshift credentials of a connection.

" } - }, - "redshiftCredentialConfiguration": { - "target": "com.amazonaws.datazone#RedshiftCredentialConfiguration", + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Redshift credentials of a connection.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#RedshiftLineageSyncConfigurationInput": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether the Amaon Redshift lineage sync configuration is enabled.

" } }, - "redshiftStorage": { - "target": "com.amazonaws.datazone#RedshiftStorage", + "schedule": { + "target": "com.amazonaws.datazone#LineageSyncSchedule", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

The schedule of the Amaon Redshift lineage sync configuration.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration details of the Amazon Redshift data source.

" + "smithy.api#documentation": "

The Amaon Redshift lineage sync configuration.

" } }, - "com.amazonaws.datazone#RedshiftRunConfigurationOutput": { + "com.amazonaws.datazone#RedshiftLineageSyncConfigurationOutput": { "type": "structure", "members": { - "accountId": { + "lineageJobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift\n data source.

", - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^\\d{12}$" + "smithy.api#documentation": "

The lineage job ID of the Amaon Redshift lineage sync configuration.

" } }, - "region": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the Amaon Redshift lineage sync configuration is enabled.

" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#LineageSyncSchedule", + "traits": { + "smithy.api#documentation": "

The schedule of teh Amaon Redshift lineage sync configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amaon Redshift lineage sync configuration.

" + } + }, + "com.amazonaws.datazone#RedshiftPropertiesInput": { + "type": "structure", + "members": { + "storage": { + "target": "com.amazonaws.datazone#RedshiftStorageProperties", + "traits": { + "smithy.api#documentation": "

The Amazon Redshift storage.

" + } + }, + "databaseName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Redshift data\n source.

", + "smithy.api#documentation": "

The Amazon Redshift database name.

", "smithy.api#length": { - "min": 4, - "max": 16 - }, - "smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" + "max": 256 + } } }, - "dataAccessRole": { + "host": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data\n source.

", - "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + "smithy.api#documentation": "

The Amazon Redshift host.

", + "smithy.api#length": { + "max": 256 + } } }, - "relationalFilterConfigurations": { - "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "port": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amaon Redshift port.

" } }, - "redshiftCredentialConfiguration": { - "target": "com.amazonaws.datazone#RedshiftCredentialConfiguration", + "credentials": { + "target": "com.amazonaws.datazone#RedshiftCredentials", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

The Amaon Redshift credentials.

" } }, - "redshiftStorage": { - "target": "com.amazonaws.datazone#RedshiftStorage", + "lineageSync": { + "target": "com.amazonaws.datazone#RedshiftLineageSyncConfigurationInput", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

The lineage sync of the Amazon Redshift.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration details of the Amazon Redshift data source.

" + "smithy.api#documentation": "

The Amazon Redshift properties.

" } }, - "com.amazonaws.datazone#RedshiftSelfGrantStatusOutput": { + "com.amazonaws.datazone#RedshiftPropertiesOutput": { "type": "structure", "members": { - "selfGrantStatusDetails": { - "target": "com.amazonaws.datazone#SelfGrantStatusDetails", + "storage": { + "target": "com.amazonaws.datazone#RedshiftStorageProperties", "traits": { - "smithy.api#documentation": "

The details for the self granting status for an Amazon Redshift data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The storage in the Amazon Redshift properties.

" } - } - }, - "traits": { - "smithy.api#documentation": "

The details for the self granting status for an Amazon Redshift data source.

" - } - }, - "com.amazonaws.datazone#RedshiftServerlessStorage": { - "type": "structure", - "members": { - "workgroupName": { + }, + "credentials": { + "target": "com.amazonaws.datazone#RedshiftCredentials", + "traits": { + "smithy.api#documentation": "

The Amazon Redshift credentials.

" + } + }, + "isProvisionedSecret": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether Amaon Redshift properties has a provisioned secret.

" + } + }, + "jdbcIamUrl": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon Redshift Serverless workgroup.

", - "smithy.api#length": { - "min": 3, - "max": 64 - }, - "smithy.api#pattern": "^[a-z0-9-]+$", - "smithy.api#required": {} + "smithy.api#documentation": "

The jdbcIam URL of the Amazon Redshift properties.

" } - } - }, - "traits": { - "smithy.api#documentation": "

The details of the Amazon Redshift Serverless workgroup storage.

" - } + }, + "jdbcUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The jdbcURL of the Amazon Redshift properties.

" + } + }, + "redshiftTempDir": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The redshiftTempDir of the Amazon Redshift properties.

" + } + }, + "lineageSync": { + "target": "com.amazonaws.datazone#RedshiftLineageSyncConfigurationOutput", + "traits": { + "smithy.api#documentation": "

The lineage syn of the Amazon Redshift properties.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#ConnectionStatus", + "traits": { + "smithy.api#documentation": "

The status in the Amazon Redshift properties.

" + } + }, + "databaseName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Redshift database name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Redshift properties.

" + } + }, + "com.amazonaws.datazone#RedshiftPropertiesPatch": { + "type": "structure", + "members": { + "storage": { + "target": "com.amazonaws.datazone#RedshiftStorageProperties", + "traits": { + "smithy.api#documentation": "

The storage in the Amazon Redshift properties patch.

" + } + }, + "databaseName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name in the Amazon Redshift properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "host": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The host in the Amazon Redshift properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "port": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The port in the Amazon Redshift properties patch.

" + } + }, + "credentials": { + "target": "com.amazonaws.datazone#RedshiftCredentials", + "traits": { + "smithy.api#documentation": "

The credentials in the Amazon Redshift properties patch.

" + } + }, + "lineageSync": { + "target": "com.amazonaws.datazone#RedshiftLineageSyncConfigurationInput", + "traits": { + "smithy.api#documentation": "

The lineage sync in the Amazon Redshift properties patch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Redshift properties patch.

" + } + }, + "com.amazonaws.datazone#RedshiftRunConfigurationInput": { + "type": "structure", + "members": { + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data\n source.

", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.

", + "smithy.api#required": {} + } + }, + "redshiftCredentialConfiguration": { + "target": "com.amazonaws.datazone#RedshiftCredentialConfiguration" + }, + "redshiftStorage": { + "target": "com.amazonaws.datazone#RedshiftStorage" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the Amazon Redshift data source.

" + } + }, + "com.amazonaws.datazone#RedshiftRunConfigurationOutput": { + "type": "structure", + "members": { + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift\n data source.

", + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Redshift data\n source.

", + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" + } + }, + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data\n source.

", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.

", + "smithy.api#required": {} + } + }, + "redshiftCredentialConfiguration": { + "target": "com.amazonaws.datazone#RedshiftCredentialConfiguration" + }, + "redshiftStorage": { + "target": "com.amazonaws.datazone#RedshiftStorage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the Amazon Redshift data source.

" + } + }, + "com.amazonaws.datazone#RedshiftSelfGrantStatusOutput": { + "type": "structure", + "members": { + "selfGrantStatusDetails": { + "target": "com.amazonaws.datazone#SelfGrantStatusDetails", + "traits": { + "smithy.api#documentation": "

The details for the self granting status for an Amazon Redshift data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details for the self granting status for an Amazon Redshift data source.

" + } + }, + "com.amazonaws.datazone#RedshiftServerlessStorage": { + "type": "structure", + "members": { + "workgroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Redshift Serverless workgroup.

", + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9-]+$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the Amazon Redshift Serverless workgroup storage.

" + } }, "com.amazonaws.datazone#RedshiftStorage": { "type": "union", @@ -22699,6 +27310,52 @@ "smithy.api#documentation": "

The details of the Amazon Redshift storage as part of the configuration of an Amazon\n Redshift data source run.

" } }, + "com.amazonaws.datazone#RedshiftStorageProperties": { + "type": "union", + "members": { + "clusterName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cluster name in the Amazon Redshift storage properties.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "workgroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The workgroup name in the Amazon Redshift storage properties.

", + "smithy.api#length": { + "max": 256 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Redshift storage properties.

" + } + }, + "com.amazonaws.datazone#Region": { + "type": "union", + "members": { + "regionName": { + "target": "com.amazonaws.datazone#RegionName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region name.

" + } + }, + "regionNamePath": { + "target": "com.amazonaws.datazone#ParameterStorePath", + "traits": { + "smithy.api#documentation": "

The region name path.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region.

" + } + }, "com.amazonaws.datazone#RegionName": { "type": "string", "traits": { @@ -23984,6 +28641,12 @@ } } }, + "com.amazonaws.datazone#RunIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, "com.amazonaws.datazone#RunStatisticsForAssets": { "type": "structure", "members": { @@ -24044,48 +28707,115 @@ } } }, - "com.amazonaws.datazone#ScheduleConfiguration": { + "com.amazonaws.datazone#SageMakerAssetType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.datazone#SageMakerResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:sagemaker:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:[\\w+=,.@-]{1,128}/[\\w+=,.@-]{1,256}$" + } + }, + "com.amazonaws.datazone#SageMakerRunConfigurationInput": { "type": "structure", "members": { - "timezone": { - "target": "com.amazonaws.datazone#Timezone", - "traits": { - "smithy.api#documentation": "

The timezone of the data source run.

" - } - }, - "schedule": { - "target": "com.amazonaws.datazone#CronString", + "trackingAssets": { + "target": "com.amazonaws.datazone#TrackingAssets", "traits": { - "smithy.api#documentation": "

The schedule of the data source runs.

" + "smithy.api#documentation": "

The tracking assets of the Amazon SageMaker run.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The details of the schedule of the data source runs.

", - "smithy.api#sensitive": {} + "smithy.api#documentation": "

The Amazon SageMaker run configuration.

" } }, - "com.amazonaws.datazone#Search": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#SearchInput" - }, - "output": { - "target": "com.amazonaws.datazone#SearchOutput" - }, - "errors": [ - { - "target": "com.amazonaws.datazone#AccessDeniedException" - }, - { - "target": "com.amazonaws.datazone#InternalServerException" - }, - { - "target": "com.amazonaws.datazone#ThrottlingException" - }, - { - "target": "com.amazonaws.datazone#ValidationException" - } + "com.amazonaws.datazone#SageMakerRunConfigurationOutput": { + "type": "structure", + "members": { + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker account ID.

", + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker Region.

", + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" + } + }, + "trackingAssets": { + "target": "com.amazonaws.datazone#TrackingAssets", + "traits": { + "smithy.api#documentation": "

The tracking assets of the Amazon SageMaker.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker run configuration.

" + } + }, + "com.amazonaws.datazone#ScheduleConfiguration": { + "type": "structure", + "members": { + "timezone": { + "target": "com.amazonaws.datazone#Timezone", + "traits": { + "smithy.api#documentation": "

The timezone of the data source run.

" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#CronString", + "traits": { + "smithy.api#documentation": "

The schedule of the data source runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the schedule of the data source runs.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#Search": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#SearchInput" + }, + "output": { + "target": "com.amazonaws.datazone#SearchOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } ], "traits": { "smithy.api#documentation": "

Searches for assets in Amazon DataZone.

", @@ -24830,6 +29560,24 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.datazone#SelfGrantStatus": { "type": "enum", "members": { @@ -24999,49 +29747,414 @@ } } }, + "com.amazonaws.datazone#SortFieldConnection": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, "com.amazonaws.datazone#SortFieldProject": { "type": "enum", "members": { "NAME": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NAME" + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.datazone#SortKey": { + "type": "enum", + "members": { + "CREATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED_AT" + } + }, + "UPDATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_AT" + } + } + } + }, + "com.amazonaws.datazone#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.datazone#SparkEmrPropertiesInput": { + "type": "structure", + "members": { + "computeArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The compute ARN of Spark EMR.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "instanceProfileArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The instance profile ARN of Spark EMR.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "javaVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The java virtual env of the Spark EMR.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "logUri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The log URI of the Spark EMR.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "pythonVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Python virtual env of the Spark EMR.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "runtimeRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The runtime role of the Spark EMR.

", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" + } + }, + "trustedCertificatesS3Uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The certificates S3 URI of the Spark EMR.

", + "smithy.api#length": { + "max": 256 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spark EMR properties.

" + } + }, + "com.amazonaws.datazone#SparkEmrPropertiesOutput": { + "type": "structure", + "members": { + "computeArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The compute ARN of the Spark EMR.

" + } + }, + "credentials": { + "target": "com.amazonaws.datazone#UsernamePassword", + "traits": { + "smithy.api#documentation": "

The credentials of the Spark EMR.

" + } + }, + "credentialsExpiration": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The credential expiration of the Spark EMR.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "governanceType": { + "target": "com.amazonaws.datazone#GovernanceType", + "traits": { + "smithy.api#documentation": "

The governance type of the Spark EMR.

" + } + }, + "instanceProfileArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The instance profile ARN of the Spark EMR.

" + } + }, + "javaVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Java virtual env of the Spark EMR.

" + } + }, + "livyEndpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The livy endpoint of the Spark EMR.

" + } + }, + "logUri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The log URI of the Spark EMR.

" + } + }, + "pythonVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Python virtual env of the Spark EMR.

" + } + }, + "runtimeRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The runtime role of the Spark EMR.

" + } + }, + "trustedCertificatesS3Uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The trusted certificate S3 URL of the Spark EMR.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spark EMR properties.

" + } + }, + "com.amazonaws.datazone#SparkEmrPropertiesPatch": { + "type": "structure", + "members": { + "computeArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The compute ARN in the Spark EMR properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "instanceProfileArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The instance profile ARN in the Spark EMR properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "javaVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Java virtual evn in the Spark EMR properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "logUri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The log URI in the Spark EMR properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "pythonVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Python virtual env in the Spark EMR properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "runtimeRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The runtime role in the Spark EMR properties patch.

", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" + } + }, + "trustedCertificatesS3Uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The trusted certificates S3 URI in the Spark EMR properties patch.

", + "smithy.api#length": { + "max": 256 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spark EMR properties patch.

" + } + }, + "com.amazonaws.datazone#SparkGlueArgs": { + "type": "structure", + "members": { + "connection": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The connection in the Spark Amazon Web Services Glue args.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spark Amazon Web Services Glue args.

" + } + }, + "com.amazonaws.datazone#SparkGluePropertiesInput": { + "type": "structure", + "members": { + "additionalArgs": { + "target": "com.amazonaws.datazone#SparkGlueArgs", + "traits": { + "smithy.api#documentation": "

The additional args in the Spark Amazon Web Services Glue properties.

" + } + }, + "glueConnectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "glueVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "idleTimeout": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The idle timeout in the Spark Amazon Web Services Glue properties.

" + } + }, + "javaVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Java virtual env in the Spark Amazon Web Services Glue properties.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "numberOfWorkers": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of workers in the Spark Amazon Web Services Glue properties.

" + } + }, + "pythonVirtualEnv": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Python virtual env in the Spark Amazon Web Services Glue properties.

", + "smithy.api#length": { + "max": 256 + } + } + }, + "workerType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The worker type in the Spark Amazon Web Services Glue properties.

", + "smithy.api#length": { + "max": 256 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spark Amazon Web Services Glue properties.

" + } + }, + "com.amazonaws.datazone#SparkGluePropertiesOutput": { + "type": "structure", + "members": { + "additionalArgs": { + "target": "com.amazonaws.datazone#SparkGlueArgs", + "traits": { + "smithy.api#documentation": "

The additional args in the Spark Amazon Web Services Glue properties.

" + } + }, + "glueConnectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties.

" + } + }, + "glueVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.

" } - } - } - }, - "com.amazonaws.datazone#SortKey": { - "type": "enum", - "members": { - "CREATED_AT": { - "target": "smithy.api#Unit", + }, + "idleTimeout": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#enumValue": "CREATED_AT" + "smithy.api#documentation": "

The idle timeout in the Spark Amazon Web Services Glue properties.

" } }, - "UPDATED_AT": { - "target": "smithy.api#Unit", + "javaVirtualEnv": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "UPDATED_AT" + "smithy.api#documentation": "

The Java virtual env in the Spark Amazon Web Services Glue properties.

" } - } - } - }, - "com.amazonaws.datazone#SortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", + }, + "numberOfWorkers": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#enumValue": "ASCENDING" + "smithy.api#documentation": "

The number of workers in the Spark Amazon Web Services Glue properties.

" } }, - "DESCENDING": { - "target": "smithy.api#Unit", + "pythonVirtualEnv": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "DESCENDING" + "smithy.api#documentation": "

The Python virtual env in the Spark Amazon Web Services Glue properties.

" + } + }, + "workerType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The worker type in the Spark Amazon Web Services Glue properties.

" } } + }, + "traits": { + "smithy.api#documentation": "

The Spark Amazon Web Services Glue properties.

" } }, "com.amazonaws.datazone#SsoUserProfileDetails": { @@ -25373,12 +30486,50 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#Status": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.datazone#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, + "com.amazonaws.datazone#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 32 + }, + "smithy.api#pattern": "^subnet-[a-z0-9]+$" + } + }, + "com.amazonaws.datazone#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.datazone#SubscribedAsset": { "type": "structure", "members": { @@ -26295,10 +31446,9 @@ } }, "manageAccessRole": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#IamRoleArn", "traits": { - "smithy.api#documentation": "

The manage access role specified in the subscription target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The manage access role specified in the subscription target.

" } }, "applicableAssetTypes": { @@ -27113,6 +32263,27 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#TokenUrlParametersMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + } + }, "com.amazonaws.datazone#Topic": { "type": "structure", "members": { @@ -27141,6 +32312,33 @@ "smithy.api#documentation": "

The topic of the notification.

" } }, + "com.amazonaws.datazone#TrackingAssetArns": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SageMakerResourceArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.datazone#TrackingAssets": { + "type": "map", + "key": { + "target": "com.amazonaws.datazone#SageMakerAssetType" + }, + "value": { + "target": "com.amazonaws.datazone#TrackingAssetArns" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.datazone#TypeName": { "type": "string", "traits": { @@ -27313,27 +32511,193 @@ "identifier": { "target": "com.amazonaws.datazone#FilterId", "traits": { - "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the asset filter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateAssetFilterOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the asset filter was created.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#FilterStatus", + "traits": { + "smithy.api#documentation": "

The status of the asset filter.

" + } + }, + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message that is displayed if the action is not completed successfully.

" + } + }, + "effectiveColumnNames": { + "target": "com.amazonaws.datazone#ColumnNameList", + "traits": { + "smithy.api#documentation": "

The column names of the asset filter.

" + } + }, + "effectiveRowFilter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The row filter of the asset filter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateConnectionInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateConnectionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/connections/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateConnectionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where a connection is to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ConnectionId", + "traits": { + "smithy.api#documentation": "

The ID of the connection to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "smithy.api#String", + "description": { + "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The name of the asset filter.

" + "smithy.api#documentation": "

The description of a connection.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } } }, - "description": { - "target": "com.amazonaws.datazone#Description", + "awsLocation": { + "target": "com.amazonaws.datazone#AwsLocation", "traits": { - "smithy.api#documentation": "

The description of the asset filter.

" + "smithy.api#documentation": "

The location where a connection is to be updated.

" } }, - "configuration": { - "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "props": { + "target": "com.amazonaws.datazone#ConnectionPropertiesPatch", "traits": { - "smithy.api#documentation": "

The configuration of the asset filter.

" + "smithy.api#documentation": "

The connection props.

" } } }, @@ -27341,78 +32705,73 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#UpdateAssetFilterOutput": { + "com.amazonaws.datazone#UpdateConnectionOutput": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.datazone#FilterId", + "connectionId": { + "target": "com.amazonaws.datazone#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#documentation": "

The ID of the connection.

", "smithy.api#required": {} } }, - "domainId": { - "target": "com.amazonaws.datazone#DomainId", + "description": { + "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The ID of the domain where the asset filter was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The connection description.

" } }, - "assetId": { - "target": "com.amazonaws.datazone#AssetId", + "domainId": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#documentation": "

The ID of the domain where a connection is to be updated.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.datazone#FilterName", + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#documentation": "

The ID of the domain unit where a connection is to be updated.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.datazone#Description", - "traits": { - "smithy.api#documentation": "

The description of the asset filter.

" - } - }, - "status": { - "target": "com.amazonaws.datazone#FilterStatus", + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The status of the asset filter.

" + "smithy.api#documentation": "

The ID of the environment where a connection is to be updated.

" } }, - "configuration": { - "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "name": { + "target": "com.amazonaws.datazone#ConnectionName", "traits": { - "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#documentation": "

The name of the connection.

", "smithy.api#required": {} } }, - "createdAt": { - "target": "com.amazonaws.datazone#CreatedAt", + "physicalEndpoints": { + "target": "com.amazonaws.datazone#PhysicalEndpoints", "traits": { - "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" + "smithy.api#documentation": "

The physical endpoints of the connection.

", + "smithy.api#required": {} } }, - "errorMessage": { - "target": "smithy.api#String", + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The error message that is displayed if the action is not completed successfully.

" + "smithy.api#documentation": "

The project ID of the connection.

" } }, - "effectiveColumnNames": { - "target": "com.amazonaws.datazone#ColumnNameList", + "props": { + "target": "com.amazonaws.datazone#ConnectionPropertiesOutput", "traits": { - "smithy.api#documentation": "

The column names of the asset filter.

" + "smithy.api#documentation": "

The connection props.

" } }, - "effectiveRowFilter": { - "target": "smithy.api#String", + "type": { + "target": "com.amazonaws.datazone#ConnectionType", "traits": { - "smithy.api#documentation": "

The row filter of the asset filter.

" + "smithy.api#documentation": "

The connection type.

", + "smithy.api#required": {} } } }, @@ -27592,8 +32951,13 @@ "environmentId": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The identifier of the environment in which a data source is to be updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The identifier of the environment in which a data source is to be updated.

" + } + }, + "connectionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The connection ID.

" } }, "configuration": { @@ -27760,6 +33124,12 @@ "smithy.api#documentation": "

The domain execution role to be updated as part of the UpdateDomain\n action.

" } }, + "serviceRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "

The service role of the domain.

" + } + }, "name": { "target": "smithy.api#String", "traits": { @@ -27813,6 +33183,12 @@ "smithy.api#documentation": "

The domain execution role to be updated as part of the UpdateDomain\n action.

" } }, + "serviceRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "

The service role of the domain.

" + } + }, "name": { "target": "smithy.api#String", "traits": { @@ -28986,6 +34362,12 @@ "traits": { "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateProject\n action.

" } + }, + "environmentDeploymentDetails": { + "target": "com.amazonaws.datazone#EnvironmentDeploymentDetails", + "traits": { + "smithy.api#documentation": "

The environment deployment details of the project.

" + } } }, "traits": { @@ -29066,6 +34448,193 @@ "traits": { "smithy.api#documentation": "

The ID of the domain unit.

" } + }, + "projectProfileId": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile.

" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationUserParametersList", + "traits": { + "smithy.api#documentation": "

The user parameters of the project.

" + } + }, + "environmentDeploymentDetails": { + "target": "com.amazonaws.datazone#EnvironmentDeploymentDetails", + "traits": { + "smithy.api#documentation": "

The environment deployment details of the project.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateProjectProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateProjectProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateProjectProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a project profile.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/project-profiles/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateProjectProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where a project profile is to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of a project profile that is to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectProfileName", + "traits": { + "smithy.api#documentation": "

The name of a project profile.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of a project profile.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#Status", + "traits": { + "smithy.api#documentation": "

The status of a project profile.

" + } + }, + "environmentConfigurations": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationsList", + "traits": { + "smithy.api#documentation": "

The environment configurations of a project profile.

" + } + }, + "domainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit where a project profile is to be updated.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateProjectProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where project profile is to be updated.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the project profile.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectProfileName", + "traits": { + "smithy.api#documentation": "

The name of the project profile.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of a project profile.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#Status", + "traits": { + "smithy.api#documentation": "

The status of the project profile.

" + } + }, + "environmentConfigurations": { + "target": "com.amazonaws.datazone#EnvironmentConfigurationsList", + "traits": { + "smithy.api#documentation": "

The environment configurations of a project profile.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created a project profile.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which a project profile is created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which a project profile was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The domain unit ID of the project profile to be updated.

" + } } }, "traits": { @@ -29708,7 +35277,7 @@ } }, "manageAccessRole": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#IamRoleArn", "traits": { "smithy.api#documentation": "

The manage access role to be updated as part of the\n UpdateSubscriptionTarget action.

" } @@ -29803,10 +35372,9 @@ } }, "manageAccessRole": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#IamRoleArn", "traits": { - "smithy.api#documentation": "

The manage access role to be updated as part of the\n UpdateSubscriptionTarget action.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The manage access role to be updated as part of the\n UpdateSubscriptionTarget action.

" } }, "applicableAssetTypes": { @@ -30229,6 +35797,37 @@ } } }, + "com.amazonaws.datazone#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + } + } + }, + "com.amazonaws.datazone#UsernamePassword": { + "type": "structure", + "members": { + "password": { + "target": "com.amazonaws.datazone#Password", + "traits": { + "smithy.api#documentation": "

The password of a connection.

", + "smithy.api#required": {} + } + }, + "username": { + "target": "com.amazonaws.datazone#Username", + "traits": { + "smithy.api#documentation": "

The username of a connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The username and password of a connection.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.datazone#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/dsql.json b/codegen/sdk-codegen/aws-models/dsql.json new file mode 100644 index 00000000000..0807319d06c --- /dev/null +++ b/codegen/sdk-codegen/aws-models/dsql.json @@ -0,0 +1,1920 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.dsql#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.dsql#Arn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Amazon Resource Name", + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:.+$" + } + }, + "com.amazonaws.dsql#ClientToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Idempotency Token", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[!-~]+$" + } + }, + "com.amazonaws.dsql#Cluster": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId" + } + }, + "properties": { + "arn": { + "target": "com.amazonaws.dsql#ClusterArn" + }, + "status": { + "target": "com.amazonaws.dsql#ClusterStatus" + }, + "creationTime": { + "target": "com.amazonaws.dsql#ClusterCreationTime" + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled" + } + }, + "create": { + "target": "com.amazonaws.dsql#CreateCluster" + }, + "read": { + "target": "com.amazonaws.dsql#GetCluster" + }, + "update": { + "target": "com.amazonaws.dsql#UpdateCluster" + }, + "delete": { + "target": "com.amazonaws.dsql#DeleteCluster" + }, + "list": { + "target": "com.amazonaws.dsql#ListClusters" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.dsql#CreateMultiRegionClusters" + }, + { + "target": "com.amazonaws.dsql#DeleteMultiRegionClusters" + } + ], + "traits": { + "aws.api#arn": { + "template": "cluster/{identifier}" + } + } + }, + "com.amazonaws.dsql#ClusterArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.dsql#DSQL", + "resource": "com.amazonaws.dsql#Cluster" + }, + "smithy.api#documentation": "Cluster ARN" + } + }, + "com.amazonaws.dsql#ClusterArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.dsql#ClusterArn" + }, + "traits": { + "smithy.api#documentation": "List of cluster arns", + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.dsql#ClusterCreationTime": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "Timestamp when the Cluster was created" + } + }, + "com.amazonaws.dsql#ClusterId": { + "type": "string", + "traits": { + "smithy.api#documentation": "The ID of the cluster" + } + }, + "com.amazonaws.dsql#ClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.dsql#ClusterSummary" + }, + "traits": { + "smithy.api#documentation": "List of clusters", + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.dsql#ClusterPropertyMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dsql#Region" + }, + "value": { + "target": "com.amazonaws.dsql#LinkedClusterProperties" + }, + "traits": { + "smithy.api#documentation": "Properties for each linked cluster" + } + }, + "com.amazonaws.dsql#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "Cluster Status" + } + }, + "com.amazonaws.dsql#ClusterSummary": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the cluster.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.dsql#ClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the properties of a cluster.

" + } + }, + "com.amazonaws.dsql#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Resource Id

" + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Resource Type

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The submitted action has conflicts.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.dsql#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#CreateClusterInput" + }, + "output": { + "target": "com.amazonaws.dsql#CreateClusterOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ConflictException" + }, + { + "target": "com.amazonaws.dsql#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create new clusters." + }, + "smithy.api#documentation": "

Creates a cluster in Amazon Aurora DSQL.

", + "smithy.api#examples": [ + { + "title": "Create Cluster", + "input": { + "deletionProtectionEnabled": false, + "tags": { + "MyKey": "MyValue" + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cluster" + } + } + }, + "com.amazonaws.dsql#CreateClusterInput": { + "type": "structure", + "members": { + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "

If enabled, you can't delete your cluster. You must first\n disable this property before you can delete your cluster.

" + } + }, + "tags": { + "target": "com.amazonaws.dsql#TagMap", + "traits": { + "smithy.api#documentation": "

A map of key and value pairs to use to tag your cluster.

", + "smithy.api#notProperty": {} + } + }, + "clientToken": { + "target": "com.amazonaws.dsql#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully, the subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.

\n

If you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#CreateClusterOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the created cluster.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.dsql#ClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the created cluster.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.dsql#ClusterStatus", + "traits": { + "smithy.api#documentation": "

The status of the created cluster.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.dsql#ClusterCreationTime", + "traits": { + "smithy.api#documentation": "

The time of when created the cluster.

", + "smithy.api#required": {} + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Whether deletion protection is enabled on this cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output Mixin", + "smithy.api#output": {} + } + }, + "com.amazonaws.dsql#CreateMultiRegionClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#CreateMultiRegionClustersInput" + }, + "output": { + "target": "com.amazonaws.dsql#CreateMultiRegionClustersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ConflictException" + }, + { + "target": "com.amazonaws.dsql#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create multi-Region clusters. This action requires the CreateMultiRegionClusters and CreateCluster permissions in each specified linked Region.", + "requiredActions": [ + "dsql:CreateCluster" + ] + }, + "smithy.api#documentation": "

Creates multi-Region clusters in Amazon Aurora DSQL. \n Multi-Region clusters require a linked Region list, which is an array\n of the Regions in which you want to create linked clusters.\n Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

", + "smithy.api#examples": [ + { + "title": "Create Multi Region Clusters", + "input": { + "linkedRegionList": [ + "us-east-1", + "us-east-2" + ], + "witnessRegion": "us-west-2" + }, + "output": { + "linkedClusterArns": [ + "arn:aws:xanadu:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345", + "arn:aws:xanadu:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321" + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/multi-region-clusters" + } + } + }, + "com.amazonaws.dsql#CreateMultiRegionClustersInput": { + "type": "structure", + "members": { + "linkedRegionList": { + "target": "com.amazonaws.dsql#RegionList", + "traits": { + "smithy.api#documentation": "

An array of the Regions in which you want to create additional clusters.

", + "smithy.api#notProperty": {}, + "smithy.api#required": {} + } + }, + "clusterProperties": { + "target": "com.amazonaws.dsql#ClusterPropertyMap", + "traits": { + "smithy.api#documentation": "

A mapping of properties to use when creating linked clusters.

", + "smithy.api#notProperty": {} + } + }, + "witnessRegion": { + "target": "com.amazonaws.dsql#Region", + "traits": { + "smithy.api#documentation": "

The witness Region of multi-Region clusters.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.dsql#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.

\n

If you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#CreateMultiRegionClustersOutput": { + "type": "structure", + "members": { + "linkedClusterArns": { + "target": "com.amazonaws.dsql#ClusterArnList", + "traits": { + "smithy.api#documentation": "

An array that contains the ARNs of all linked clusters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dsql#DSQL": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.dsql#ListTagsForResource" + }, + { + "target": "com.amazonaws.dsql#TagResource" + }, + { + "target": "com.amazonaws.dsql#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.dsql#Cluster" + } + ], + "errors": [ + { + "target": "com.amazonaws.dsql#AccessDeniedException" + }, + { + "target": "com.amazonaws.dsql#InternalServerException" + }, + { + "target": "com.amazonaws.dsql#ThrottlingException" + }, + { + "target": "com.amazonaws.dsql#ValidationException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "DSQL", + "arnNamespace": "dsql", + "endpointPrefix": "dsql", + "cloudTrailEventSource": "dsql.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "dsql" + }, + "aws.endpoints#dualStackOnlyEndpoints": {}, + "aws.endpoints#standardRegionalEndpoints": {}, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

This is an interface reference for Amazon Aurora DSQL.\n It contains documentation for one of the programming or\n command line interfaces you can use to manage Amazon Aurora DSQL.

\n

Amazon Aurora DSQL is a serverless, distributed SQL\n database suitable for workloads of any size. Aurora DSQL\n is available in both single-Region and multi-Region configurations,\n so your clusters and databases are always available even if an\n Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL\n lets you focus on using your data to acquire new insights for your\n business and customers.

", + "smithy.api#title": "Amazon Aurora DSQL", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://dsql-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dsql.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For custom endpoint with region not set and fips disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql-fips.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql-fips.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dsql.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.dsql#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#DeleteClusterInput" + }, + "output": { + "target": "com.amazonaws.dsql#DeleteClusterOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ConflictException" + }, + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a cluster and all of its data." + }, + "smithy.api#documentation": "

Deletes a cluster in Amazon Aurora DSQL.

", + "smithy.api#examples": [ + { + "title": "Delete Cluster", + "input": { + "identifier": "kiqenqglxyl2snyvkvnj2c3s2e" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/cluster/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.dsql#DeleteClusterInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the cluster to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.dsql#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.

\n

If you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.

", + "smithy.api#httpQuery": "client-token", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#DeleteClusterOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the deleted cluster.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.dsql#ClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the deleted cluster.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.dsql#ClusterStatus", + "traits": { + "smithy.api#documentation": "

The status of the cluster.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.dsql#ClusterCreationTime", + "traits": { + "smithy.api#documentation": "

The time of when the cluster was created.

", + "smithy.api#required": {} + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether deletion protection was enabled on the cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output Mixin", + "smithy.api#output": {} + } + }, + "com.amazonaws.dsql#DeleteMultiRegionClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#DeleteMultiRegionClustersInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ConflictException" + }, + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete multi-Region clusters. This action requires the DeleteMultiRegionClusters and DeleteCluster permissions in each specified linked Region.", + "requiredActions": [ + "dsql:DeleteCluster" + ] + }, + "smithy.api#documentation": "

Deletes a multi-Region cluster in Amazon Aurora DSQL.

", + "smithy.api#examples": [ + { + "title": "Delete Multi Region Clusters", + "input": { + "linkedClusterArns": [ + "arn:aws:xanadu:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345", + "arn:aws:xanadu:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321" + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/multi-region-clusters" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.dsql#DeleteMultiRegionClustersInput": { + "type": "structure", + "members": { + "linkedClusterArns": { + "target": "com.amazonaws.dsql#ClusterArnList", + "traits": { + "smithy.api#documentation": "

The ARNs of the clusters linked to the cluster you want to delete. \n also deletes these clusters as part of the operation.

", + "smithy.api#httpQuery": "linked-cluster-arns", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.dsql#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.

\n

If you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.

", + "smithy.api#httpQuery": "client-token", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#DeletionProtectionEnabled": { + "type": "boolean", + "traits": { + "smithy.api#documentation": "Deletion Protection" + } + }, + "com.amazonaws.dsql#GetCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#GetClusterInput" + }, + "output": { + "target": "com.amazonaws.dsql#GetClusterOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get information about a cluster." + }, + "smithy.api#documentation": "

Retrieves information about a cluster.

", + "smithy.api#examples": [ + { + "title": "Get Cluster", + "input": { + "identifier": "kiqenqglxyl2snyvkvnj2c3s2e" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/cluster/{identifier}" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetClusterNotFound", + "params": { + "identifier": "someIdentifier" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.dsql#ResourceNotFoundException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ], + "smithy.waiters#waitable": { + "ClusterActive": { + "documentation": "Wait until a Cluster is ACTIVE", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "comparator": "stringEquals", + "expected": "ACTIVE" + } + } + } + ] + }, + "ClusterNotExists": { + "documentation": "Wait until a Cluster is gone", + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ] + } + } + } + }, + "com.amazonaws.dsql#GetClusterInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the cluster to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#GetClusterOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the retrieved cluster.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.dsql#ClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the retrieved cluster.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.dsql#ClusterStatus", + "traits": { + "smithy.api#documentation": "

The status of the retrieved cluster.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.dsql#ClusterCreationTime", + "traits": { + "smithy.api#documentation": "

The time of when the cluster was created.

", + "smithy.api#required": {} + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Whether deletion protection is enabled in this cluster.

", + "smithy.api#required": {} + } + }, + "witnessRegion": { + "target": "com.amazonaws.dsql#Region", + "traits": { + "smithy.api#documentation": "

The witness Region of the cluster. Applicable only for \n multi-Region clusters.

", + "smithy.api#notProperty": {} + } + }, + "linkedClusterArns": { + "target": "com.amazonaws.dsql#ClusterArnList", + "traits": { + "smithy.api#documentation": "

The ARNs of the clusters linked to the retrieved cluster.

", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output Mixin", + "smithy.api#output": {} + } + }, + "com.amazonaws.dsql#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Retry after seconds.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has failed because of an unknown error, \n exception or failure.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.dsql#LinkedClusterProperties": { + "type": "structure", + "members": { + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "

Whether deletion protection is enabled.

" + } + }, + "tags": { + "target": "com.amazonaws.dsql#TagMap", + "traits": { + "smithy.api#documentation": "

A map of key and value pairs the linked cluster is tagged with.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of linked clusters.

" + } + }, + "com.amazonaws.dsql#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#ListClustersInput" + }, + "output": { + "target": "com.amazonaws.dsql#ListClustersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get a list of cluster ARNs associated with the current endpoint and account." + }, + "smithy.api#documentation": "

Retrieves information about a list of clusters.

", + "smithy.api#examples": [ + { + "title": "List Clusters", + "input": { + "maxResults": 20 + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/cluster" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "clusters" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListClustersSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.dsql#ListClustersInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.dsql#MaxResults", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. \n You can use nextToken to display the next page of results.

", + "smithy.api#httpQuery": "max-results" + } + }, + "nextToken": { + "target": "com.amazonaws.dsql#NextToken", + "traits": { + "smithy.api#documentation": "

If your initial ListClusters operation returns a nextToken,\n you can include the returned nextToken in following ListClusters operations, \n which returns results in the next page.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#ListClustersOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.dsql#NextToken", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of \n nextToken is a unique pagination token for each page. To retrieve the \n next page, make the call again using the returned token.

" + } + }, + "clusters": { + "target": "com.amazonaws.dsql#ClusterList", + "traits": { + "smithy.api#documentation": "

An array of the returned clusters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dsql#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.dsql#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list all tags for an ARN." + }, + "smithy.api#documentation": "

Lists all of the tags for a resource.

", + "smithy.api#examples": [ + { + "title": "List Tags For Resource", + "input": { + "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e" + } + } + ], + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.dsql#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.dsql#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource for which you want to list the tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.dsql#TagMap", + "traits": { + "smithy.api#documentation": "

A map of key and value pairs that you used to tag your resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dsql#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Max results that will be returned per page", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dsql#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Opaque token used to retrieve next page" + } + }, + "com.amazonaws.dsql#Region": { + "type": "string", + "traits": { + "smithy.api#documentation": "AWS Region name (e.g.: 'us-east-1')", + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.dsql#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dsql#Region" + }, + "traits": { + "smithy.api#documentation": "List of regions", + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.dsql#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Hypothetical identifier of the resource which does not exist", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Hypothetical type of the resource which does not exist", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.dsql#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifier of the resource affected", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of the resource affected", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Service Quotas requirement to identify originating service", + "smithy.api#required": {} + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Service Quotas requirement to identify originating quota", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The service limit was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.dsql#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Unique tag key, maximum 128 Unicode characters in UTF-8", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.:/=+\\-@ ]*$" + } + }, + "com.amazonaws.dsql#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.dsql#TagKey" + }, + "traits": { + "smithy.api#documentation": "List of tag keys", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.dsql#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dsql#TagKey" + }, + "value": { + "target": "com.amazonaws.dsql#TagValue" + }, + "traits": { + "smithy.api#documentation": "Map of tags", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.dsql#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#TagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dsql#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to add tags to an ARN." + }, + "smithy.api#documentation": "

Tags a resource with a map of key and value pairs.

", + "smithy.api#examples": [ + { + "title": "Tag Resource", + "input": { + "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e", + "tags": { + "MyKey": "MyValue" + } + } + } + ], + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.dsql#TagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.dsql#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that you want to tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.dsql#TagMap", + "traits": { + "smithy.api#documentation": "

A map of key and value pairs to use to tag your resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Tag value, maximum 256 Unicode characters in UTF-8", + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.:/=+\\-@ ]*$" + } + }, + "com.amazonaws.dsql#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Service Quotas requirement to identify originating service" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Service Quotas requirement to identify originating quota" + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Advice to clients on when the call can be safely retried", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.dsql#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#UntagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to remove tags from an ARN." + }, + "smithy.api#documentation": "

Removes a tag from a resource.

", + "smithy.api#examples": [ + { + "title": "Untag Resource", + "input": { + "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e", + "tagKeys": [ + "MyKeyA", + "MyKeyB" + ] + } + } + ], + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.dsql#UntagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.dsql#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource from which to remove tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.dsql#TagKeyList", + "traits": { + "smithy.api#documentation": "

The array of keys of the tags that you want to remove.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#UpdateClusterInput" + }, + "output": { + "target": "com.amazonaws.dsql#UpdateClusterOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#ConflictException" + }, + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to modify the deletion protection status of a given cluster." + }, + "smithy.api#documentation": "

Updates a cluster.

", + "smithy.api#examples": [ + { + "title": "Update Cluster", + "input": { + "identifier": "kiqenqglxyl2snyvkvnj2c3s2e", + "deletionProtectionEnabled": false + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cluster/{identifier}" + } + } + }, + "com.amazonaws.dsql#UpdateClusterInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the cluster you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection in your cluster.

" + } + }, + "clientToken": { + "target": "com.amazonaws.dsql#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.

\n

If you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#UpdateClusterOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the cluster to update.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.dsql#ClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the updated cluster.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.dsql#ClusterStatus", + "traits": { + "smithy.api#documentation": "

The status of the updated cluster.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.dsql#ClusterCreationTime", + "traits": { + "smithy.api#documentation": "

The time of when the cluster was created.

", + "smithy.api#required": {} + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Whether deletion protection is enabled for the updated cluster.

", + "smithy.api#required": {} + } + }, + "witnessRegion": { + "target": "com.amazonaws.dsql#Region", + "traits": { + "smithy.api#documentation": "

The Region that receives all data you write to linked clusters.

", + "smithy.api#notProperty": {} + } + }, + "linkedClusterArns": { + "target": "com.amazonaws.dsql#ClusterArnList", + "traits": { + "smithy.api#documentation": "

The ARNs of the clusters linked to the updated cluster. Applicable\n only for multi-Region clusters.

", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output Mixin", + "smithy.api#output": {} + } + }, + "com.amazonaws.dsql#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.dsql#ValidationExceptionReason", + "traits": { + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.dsql#ValidationExceptionFieldList" + } + }, + "traits": { + "smithy.api#documentation": "

The input failed to satisfy the constraints specified by an Amazon Web Services service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.dsql#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the field.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A message describing why this field failed validation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Stores information about a field passed inside a \n request that resulted in an validation error.

" + } + }, + "com.amazonaws.dsql#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.dsql#ValidationExceptionField" + }, + "traits": { + "smithy.api#documentation": "List of fields that caused the error" + } + }, + "com.amazonaws.dsql#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "DELETION_PROTECTION_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deletionProtectionEnabled" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + }, + "traits": { + "smithy.api#documentation": "Reason the request failed validation" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/dynamodb.json b/codegen/sdk-codegen/aws-models/dynamodb.json index fa4dd5dc932..f5cf40a15a9 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.json @@ -2460,6 +2460,9 @@ { "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, { "target": "com.amazonaws.dynamodb#RequestLimitExceeded" }, @@ -4040,9 +4043,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", + "signingRegion": "us-east-1", "signingName": "dynamodb", - "signingRegion": "us-east-1" + "name": "sigv4" } ] }, @@ -9241,6 +9244,23 @@ "target": "com.amazonaws.dynamodb#AttributeValue" } }, + "com.amazonaws.dynamodb#MultiRegionConsistency": { + "type": "enum", + "members": { + "EVENTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENTUAL" + } + }, + "STRONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRONG" + } + } + } + }, "com.amazonaws.dynamodb#NextTokenString": { "type": "string" }, @@ -9726,6 +9746,9 @@ { "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, { "target": "com.amazonaws.dynamodb#RequestLimitExceeded" }, @@ -10813,6 +10836,18 @@ "target": "com.amazonaws.dynamodb#ReplicaUpdate" } }, + "com.amazonaws.dynamodb#ReplicatedWriteConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because one or more items in the request are being modified by a request in another Region.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.dynamodb#ReplicationGroupUpdate": { "type": "structure", "members": { @@ -12239,6 +12274,12 @@ "traits": { "smithy.api#documentation": "

Describes the warm throughput value of the base table.

" } + }, + "MultiRegionConsistency": { + "target": "com.amazonaws.dynamodb#MultiRegionConsistency", + "traits": { + "smithy.api#documentation": "

Indicates one of the following consistency modes for a global table:

\n \n

If you don't specify this field, the global table consistency mode defaults to EVENTUAL.

" + } } }, "traits": { @@ -13320,6 +13361,9 @@ { "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, { "target": "com.amazonaws.dynamodb#RequestLimitExceeded" }, @@ -13744,6 +13788,12 @@ "smithy.api#documentation": "

Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.

" } }, + "MultiRegionConsistency": { + "target": "com.amazonaws.dynamodb#MultiRegionConsistency", + "traits": { + "smithy.api#documentation": "

Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

\n

You can specify one of the following consistency modes:

\n \n

If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.

" + } + }, "OnDemandThroughput": { "target": "com.amazonaws.dynamodb#OnDemandThroughput", "traits": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index 7c32536a47b..b8a441b21ee 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -105,6 +105,9 @@ { "target": "com.amazonaws.glue#CreateBlueprint" }, + { + "target": "com.amazonaws.glue#CreateCatalog" + }, { "target": "com.amazonaws.glue#CreateClassifier" }, @@ -129,6 +132,15 @@ { "target": "com.amazonaws.glue#CreateDevEndpoint" }, + { + "target": "com.amazonaws.glue#CreateIntegration" + }, + { + "target": "com.amazonaws.glue#CreateIntegrationResourceProperty" + }, + { + "target": "com.amazonaws.glue#CreateIntegrationTableProperties" + }, { "target": "com.amazonaws.glue#CreateJob" }, @@ -177,6 +189,9 @@ { "target": "com.amazonaws.glue#DeleteBlueprint" }, + { + "target": "com.amazonaws.glue#DeleteCatalog" + }, { "target": "com.amazonaws.glue#DeleteClassifier" }, @@ -207,6 +222,12 @@ { "target": "com.amazonaws.glue#DeleteDevEndpoint" }, + { + "target": "com.amazonaws.glue#DeleteIntegration" + }, + { + "target": "com.amazonaws.glue#DeleteIntegrationTableProperties" + }, { "target": "com.amazonaws.glue#DeleteJob" }, @@ -258,6 +279,18 @@ { "target": "com.amazonaws.glue#DeleteWorkflow" }, + { + "target": "com.amazonaws.glue#DescribeConnectionType" + }, + { + "target": "com.amazonaws.glue#DescribeEntity" + }, + { + "target": "com.amazonaws.glue#DescribeInboundIntegrations" + }, + { + "target": "com.amazonaws.glue#DescribeIntegrations" + }, { "target": "com.amazonaws.glue#GetBlueprint" }, @@ -267,9 +300,15 @@ { "target": "com.amazonaws.glue#GetBlueprintRuns" }, + { + "target": "com.amazonaws.glue#GetCatalog" + }, { "target": "com.amazonaws.glue#GetCatalogImportStatus" }, + { + "target": "com.amazonaws.glue#GetCatalogs" + }, { "target": "com.amazonaws.glue#GetClassifier" }, @@ -345,6 +384,15 @@ { "target": "com.amazonaws.glue#GetDevEndpoints" }, + { + "target": "com.amazonaws.glue#GetEntityRecords" + }, + { + "target": "com.amazonaws.glue#GetIntegrationResourceProperty" + }, + { + "target": "com.amazonaws.glue#GetIntegrationTableProperties" + }, { "target": "com.amazonaws.glue#GetJob" }, @@ -483,6 +531,9 @@ { "target": "com.amazonaws.glue#ListColumnStatisticsTaskRuns" }, + { + "target": "com.amazonaws.glue#ListConnectionTypes" + }, { "target": "com.amazonaws.glue#ListCrawlers" }, @@ -513,6 +564,9 @@ { "target": "com.amazonaws.glue#ListDevEndpoints" }, + { + "target": "com.amazonaws.glue#ListEntities" + }, { "target": "com.amazonaws.glue#ListJobs" }, @@ -546,6 +600,9 @@ { "target": "com.amazonaws.glue#ListWorkflows" }, + { + "target": "com.amazonaws.glue#ModifyIntegration" + }, { "target": "com.amazonaws.glue#PutDataCatalogEncryptionSettings" }, @@ -657,6 +714,9 @@ { "target": "com.amazonaws.glue#UpdateBlueprint" }, + { + "target": "com.amazonaws.glue#UpdateCatalog" + }, { "target": "com.amazonaws.glue#UpdateClassifier" }, @@ -687,6 +747,12 @@ { "target": "com.amazonaws.glue#UpdateDevEndpoint" }, + { + "target": "com.amazonaws.glue#UpdateIntegrationResourceProperty" + }, + { + "target": "com.amazonaws.glue#UpdateIntegrationTableProperties" + }, { "target": "com.amazonaws.glue#UpdateJob" }, @@ -1734,6 +1800,17 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#AccessToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.glue#AccountId": { "type": "string", "traits": { @@ -2002,6 +2079,51 @@ } } }, + "com.amazonaws.glue#AllowedValue": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.glue#AllowedValueDescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the allowed value.

" + } + }, + "Value": { + "target": "com.amazonaws.glue#AllowedValueValueString", + "traits": { + "smithy.api#documentation": "

The value allowed for the property.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a value allowed for a property.

" + } + }, + "com.amazonaws.glue#AllowedValueDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.glue#AllowedValueValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#AllowedValues": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#AllowedValue" + } + }, "com.amazonaws.glue#AllowedValuesStringList": { "type": "list", "member": { @@ -2298,6 +2420,16 @@ "target": "com.amazonaws.glue#StatisticAnnotation" } }, + "com.amazonaws.glue#ApiVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.-]*$" + } + }, "com.amazonaws.glue#ApplyMapping": { "type": "structure", "members": { @@ -2438,6 +2570,45 @@ } } }, + "com.amazonaws.glue#AuthConfiguration": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.glue#Property", + "traits": { + "smithy.api#documentation": "

The type of authentication for a connection.

", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.glue#Property", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Secrets Manager.

" + } + }, + "OAuth2Properties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs for the OAuth2 properties. Each value is a a Property object.

" + } + }, + "BasicAuthenticationProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs for the OAuth2 properties. Each value is a a Property object.

" + } + }, + "CustomAuthenticationProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs for the custom authentication properties. Each value is a a Property object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authentication configuration for a connection returned by the DescribeConnectionType API.

" + } + }, "com.amazonaws.glue#AuthTokenString": { "type": "string", "traits": { @@ -2494,6 +2665,24 @@ "traits": { "smithy.api#documentation": "

The secret manager ARN to store credentials in the CreateConnection request.

" } + }, + "KmsKeyArn": { + "target": "com.amazonaws.glue#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.

" + } + }, + "BasicAuthenticationCredentials": { + "target": "com.amazonaws.glue#BasicAuthenticationCredentials", + "traits": { + "smithy.api#documentation": "

The credentials used when the authentication type is basic authentication.

" + } + }, + "CustomAuthenticationCredentials": { + "target": "com.amazonaws.glue#CredentialMap", + "traits": { + "smithy.api#documentation": "

The credentials used when the authentication type is custom authentication.

" + } } }, "traits": { @@ -2520,9 +2709,21 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } } } }, + "com.amazonaws.glue#AuthenticationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#AuthenticationType" + } + }, "com.amazonaws.glue#AuthorizationCode": { "type": "string", "traits": { @@ -2621,6 +2822,26 @@ "target": "com.amazonaws.glue#BackfillError" } }, + "com.amazonaws.glue#BasicAuthenticationCredentials": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.glue#Username", + "traits": { + "smithy.api#documentation": "

The username to connect to the data source.

" + } + }, + "Password": { + "target": "com.amazonaws.glue#Password", + "traits": { + "smithy.api#documentation": "

The password to connect to the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For supplying basic auth credentials when not providing a SecretArn value.

" + } + }, "com.amazonaws.glue#BasicCatalogTarget": { "type": "structure", "members": { @@ -4495,6 +4716,9 @@ "target": "com.amazonaws.glue#Blueprint" } }, + "com.amazonaws.glue#Bool": { + "type": "boolean" + }, "com.amazonaws.glue#Boolean": { "type": "boolean", "traits": { @@ -4831,6 +5055,116 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#Capabilities": { + "type": "structure", + "members": { + "SupportedAuthenticationTypes": { + "target": "com.amazonaws.glue#AuthenticationTypes", + "traits": { + "smithy.api#documentation": "

A list of supported authentication types.

", + "smithy.api#required": {} + } + }, + "SupportedDataOperations": { + "target": "com.amazonaws.glue#DataOperations", + "traits": { + "smithy.api#documentation": "

A list of supported data operations.

", + "smithy.api#required": {} + } + }, + "SupportedComputeEnvironments": { + "target": "com.amazonaws.glue#ComputeEnvironments", + "traits": { + "smithy.api#documentation": "

A list of supported compute environments.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the supported authentication types returned by the DescribeConnectionType API.

" + } + }, + "com.amazonaws.glue#Catalog": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the catalog. To grant access to the default catalog, this field should not be provided.

" + } + }, + "Name": { + "target": "com.amazonaws.glue#CatalogNameString", + "traits": { + "smithy.api#documentation": "

The name of the catalog. Cannot be the same as the account ID.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the catalog resource.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.

" + } + }, + "Parameters": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map array of key-value pairs that define parameters and properties of the catalog.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the catalog was created.

" + } + }, + "UpdateTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the catalog was last updated.

" + } + }, + "TargetRedshiftCatalog": { + "target": "com.amazonaws.glue#TargetRedshiftCatalog", + "traits": { + "smithy.api#documentation": "

A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

" + } + }, + "FederatedCatalog": { + "target": "com.amazonaws.glue#FederatedCatalog", + "traits": { + "smithy.api#documentation": "

A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

" + } + }, + "CatalogProperties": { + "target": "com.amazonaws.glue#CatalogPropertiesOutput", + "traits": { + "smithy.api#documentation": "

A CatalogProperties object that specifies data lake access properties and other custom properties.

" + } + }, + "CreateTableDefaultPermissions": { + "target": "com.amazonaws.glue#PrincipalPermissionsList", + "traits": { + "smithy.api#documentation": "

An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

" + } + }, + "CreateDatabaseDefaultPermissions": { + "target": "com.amazonaws.glue#PrincipalPermissionsList", + "traits": { + "smithy.api#documentation": "

An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The catalog object represents a logical grouping of databases in the Glue Data Catalog or a federated source. You can now create a Redshift-federated catalog or a catalog containing resource links to Redshift databases in another account or region.

" + } + }, "com.amazonaws.glue#CatalogDeltaSource": { "type": "structure", "members": { @@ -5010,6 +5344,56 @@ "smithy.api#documentation": "

A structure containing migration status information.

" } }, + "com.amazonaws.glue#CatalogInput": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.

" + } + }, + "FederatedCatalog": { + "target": "com.amazonaws.glue#FederatedCatalog", + "traits": { + "smithy.api#documentation": "

A FederatedCatalog object. A FederatedCatalog structure that references an entity outside the Glue Data Catalog, for example a Redshift database.

" + } + }, + "Parameters": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map array of key-value pairs that define the parameters and properties of the catalog.

" + } + }, + "TargetRedshiftCatalog": { + "target": "com.amazonaws.glue#TargetRedshiftCatalog", + "traits": { + "smithy.api#documentation": "

A TargetRedshiftCatalog object that describes a target catalog for resource linking.

" + } + }, + "CatalogProperties": { + "target": "com.amazonaws.glue#CatalogProperties", + "traits": { + "smithy.api#documentation": "

A CatalogProperties object that specifies data lake access properties and other custom properties.

" + } + }, + "CreateTableDefaultPermissions": { + "target": "com.amazonaws.glue#PrincipalPermissionsList", + "traits": { + "smithy.api#documentation": "

An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.

" + } + }, + "CreateDatabaseDefaultPermissions": { + "target": "com.amazonaws.glue#PrincipalPermissionsList", + "traits": { + "smithy.api#documentation": "

An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes catalog properties.

" + } + }, "com.amazonaws.glue#CatalogKafkaSource": { "type": "structure", "members": { @@ -5116,6 +5500,62 @@ "smithy.api#documentation": "

Specifies a Kinesis data source in the Glue Data Catalog.

" } }, + "com.amazonaws.glue#CatalogList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Catalog" + } + }, + "com.amazonaws.glue#CatalogNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^(?!(.*[.\\/\\\\]|aws:)).*$" + } + }, + "com.amazonaws.glue#CatalogProperties": { + "type": "structure", + "members": { + "DataLakeAccessProperties": { + "target": "com.amazonaws.glue#DataLakeAccessProperties", + "traits": { + "smithy.api#documentation": "

A DataLakeAccessProperties object that specifies properties to configure data lake access for your catalog resource in the Glue Data Catalog.

" + } + }, + "CustomProperties": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

Additional key-value properties for the catalog, such as column statistics optimizations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that specifies data lake access properties and other custom properties.

" + } + }, + "com.amazonaws.glue#CatalogPropertiesOutput": { + "type": "structure", + "members": { + "DataLakeAccessProperties": { + "target": "com.amazonaws.glue#DataLakeAccessPropertiesOutput", + "traits": { + "smithy.api#documentation": "

A DataLakeAccessProperties object with input properties to configure data lake access for your catalog resource in the Glue Data Catalog.

" + } + }, + "CustomProperties": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

Additional key-value properties for the catalog, such as column statistics optimizations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Property attributes that include configuration properties for the catalog resource.

" + } + }, "com.amazonaws.glue#CatalogSchemaChangePolicy": { "type": "structure", "members": { @@ -5222,6 +5662,9 @@ "target": "com.amazonaws.glue#CatalogTarget" } }, + "com.amazonaws.glue#Category": { + "type": "string" + }, "com.amazonaws.glue#CheckSchemaVersionValidity": { "type": "operation", "input": { @@ -6462,6 +6905,24 @@ "traits": { "smithy.api#documentation": "

Name of the security configuration that is used to encrypt CloudWatch logs.

" } + }, + "ScheduleType": { + "target": "com.amazonaws.glue#ScheduleType", + "traits": { + "smithy.api#documentation": "

The type of schedule for a column statistics task. Possible values may be CRON or AUTO.

" + } + }, + "SettingSource": { + "target": "com.amazonaws.glue#SettingSource", + "traits": { + "smithy.api#documentation": "

The source of setting the column statistics task. Possible values may be CATALOG or TABLE.

" + } + }, + "LastExecutionAttempt": { + "target": "com.amazonaws.glue#ExecutionAttempt", + "traits": { + "smithy.api#documentation": "

The last ExecutionAttempt for the column statistics task run.

" + } } }, "traits": { @@ -6705,6 +7166,139 @@ } } }, + "com.amazonaws.glue#ComputeEnvironment": { + "type": "enum", + "members": { + "SPARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPARK" + } + }, + "ATHENA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATHENA" + } + }, + "PYTHON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON" + } + } + } + }, + "com.amazonaws.glue#ComputeEnvironmentConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#ComputeEnvironmentName", + "traits": { + "smithy.api#documentation": "

A name for the compute environment configuration.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#ComputeEnvironmentConfigurationDescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the compute environment.

", + "smithy.api#required": {} + } + }, + "ComputeEnvironment": { + "target": "com.amazonaws.glue#ComputeEnvironment", + "traits": { + "smithy.api#documentation": "

The type of compute environment.

", + "smithy.api#required": {} + } + }, + "SupportedAuthenticationTypes": { + "target": "com.amazonaws.glue#AuthenticationTypes", + "traits": { + "smithy.api#documentation": "

The supported authentication types for the compute environment.

", + "smithy.api#required": {} + } + }, + "ConnectionOptions": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

The parameters used as connection options for the compute environment.

", + "smithy.api#required": {} + } + }, + "ConnectionPropertyNameOverrides": { + "target": "com.amazonaws.glue#PropertyNameOverrides", + "traits": { + "smithy.api#documentation": "

The connection property name overrides for the compute environment.

", + "smithy.api#required": {} + } + }, + "ConnectionOptionNameOverrides": { + "target": "com.amazonaws.glue#PropertyNameOverrides", + "traits": { + "smithy.api#documentation": "

The connection option name overrides for the compute environment.

", + "smithy.api#required": {} + } + }, + "ConnectionPropertiesRequiredOverrides": { + "target": "com.amazonaws.glue#ListOfString", + "traits": { + "smithy.api#default": [], + "smithy.api#documentation": "

The connection properties that are required as overrides for the compute environment.

", + "smithy.api#required": {} + } + }, + "PhysicalConnectionPropertiesRequired": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether PhysicalConnectionProperties are required for the compute environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object containing configuration for a compute environment (such as Spark, Python or Athena) returned by the DescribeConnectionType API.

" + } + }, + "com.amazonaws.glue#ComputeEnvironmentConfigurationDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.glue#ComputeEnvironmentConfigurationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#ComputeEnvironmentName" + }, + "value": { + "target": "com.amazonaws.glue#ComputeEnvironmentConfiguration" + } + }, + "com.amazonaws.glue#ComputeEnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ComputeEnvironment" + } + }, + "com.amazonaws.glue#ComputeEnvironmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#ComputeEnvironments": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ComputeEnvironment" + } + }, "com.amazonaws.glue#ConcurrentModificationException": { "type": "structure", "members": { @@ -6956,13 +7550,25 @@ "ConnectionProperties": { "target": "com.amazonaws.glue#ConnectionProperties", "traits": { - "smithy.api#documentation": "

These key-value pairs define parameters for the connection:

\n " + "smithy.api#documentation": "

These key-value pairs define parameters for the connection when using the version 1 Connection schema:

\n " + } + }, + "SparkProperties": { + "target": "com.amazonaws.glue#PropertyMap", + "traits": { + "smithy.api#documentation": "

Connection properties specific to the Spark compute environment.

" } }, "AthenaProperties": { "target": "com.amazonaws.glue#PropertyMap", "traits": { - "smithy.api#documentation": "

This field is not currently used.

" + "smithy.api#documentation": "

Connection properties specific to the Athena compute environment.

" + } + }, + "PythonProperties": { + "target": "com.amazonaws.glue#PropertyMap", + "traits": { + "smithy.api#documentation": "

Connection properties specific to the Python compute environment.

" } }, "PhysicalConnectionRequirements": { @@ -7012,6 +7618,18 @@ "traits": { "smithy.api#documentation": "

The authentication properties of the connection.

" } + }, + "ConnectionSchemaVersion": { + "target": "com.amazonaws.glue#ConnectionSchemaVersion", + "traits": { + "smithy.api#documentation": "

The version of the connection schema for this connection. Version 2 supports properties for specific compute environments.

" + } + }, + "CompatibleComputeEnvironments": { + "target": "com.amazonaws.glue#ComputeEnvironmentList", + "traits": { + "smithy.api#documentation": "

A list of compute environments compatible with the connection.

" + } } }, "traits": { @@ -7037,7 +7655,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#ConnectionType", "traits": { - "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n \n

\n SFTP is not supported.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

", + "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n \n

Additionally, a ConnectionType for the following SaaS connectors is supported:

\n \n

For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide.

\n

\n SFTP is not supported.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

", "smithy.api#required": {} } }, @@ -7054,10 +7672,22 @@ "smithy.api#required": {} } }, + "SparkProperties": { + "target": "com.amazonaws.glue#PropertyMap", + "traits": { + "smithy.api#documentation": "

Connection properties specific to the Spark compute environment.

" + } + }, "AthenaProperties": { "target": "com.amazonaws.glue#PropertyMap", "traits": { - "smithy.api#documentation": "

This field is not currently used.

" + "smithy.api#documentation": "

Connection properties specific to the Athena compute environment.

" + } + }, + "PythonProperties": { + "target": "com.amazonaws.glue#PropertyMap", + "traits": { + "smithy.api#documentation": "

Connection properties specific to the Python compute environment.

" } }, "PhysicalConnectionRequirements": { @@ -7069,14 +7699,20 @@ "AuthenticationConfiguration": { "target": "com.amazonaws.glue#AuthenticationConfigurationInput", "traits": { - "smithy.api#documentation": "

The authentication properties of the connection. Used for a Salesforce connection.

" + "smithy.api#documentation": "

The authentication properties of the connection.

" } }, "ValidateCredentials": { "target": "com.amazonaws.glue#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.

" + "smithy.api#documentation": "

A flag to validate the credentials during create connection. Default is true.

" + } + }, + "ValidateForComputeEnvironments": { + "target": "com.amazonaws.glue#ComputeEnvironmentList", + "traits": { + "smithy.api#documentation": "

The compute environments that the specified connection properties are validated against.

" } } }, @@ -7093,6 +7729,21 @@ "com.amazonaws.glue#ConnectionName": { "type": "string" }, + "com.amazonaws.glue#ConnectionOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#OptionKey" + }, + "value": { + "target": "com.amazonaws.glue#OptionValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.glue#ConnectionPasswordEncryption": { "type": "structure", "members": { @@ -7289,30 +7940,6 @@ "smithy.api#enumValue": "ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD" } }, - "SECRET_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECRET_ID" - } - }, - "CONNECTOR_URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTOR_URL" - } - }, - "CONNECTOR_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTOR_TYPE" - } - }, - "CONNECTOR_CLASS_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTOR_CLASS_NAME" - } - }, "KAFKA_SASL_MECHANISM": { "target": "smithy.api#Unit", "traits": { @@ -7385,6 +8012,42 @@ "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_PRINCIPAL" } }, + "SECRET_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRET_ID" + } + }, + "CONNECTOR_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTOR_URL" + } + }, + "CONNECTOR_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTOR_TYPE" + } + }, + "CONNECTOR_CLASS_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTOR_CLASS_NAME" + } + }, + "ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDPOINT" + } + }, + "ENDPOINT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDPOINT_TYPE" + } + }, "ROLE_ARN": { "target": "smithy.api#Unit", "traits": { @@ -7417,6 +8080,15 @@ } } }, + "com.amazonaws.glue#ConnectionSchemaVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.glue#ConnectionStatus": { "type": "enum", "members": { @@ -7502,9 +8174,155 @@ "traits": { "smithy.api#enumValue": "VIEW_VALIDATION_ATHENA" } + }, + "GOOGLEADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLEADS" + } + }, + "GOOGLESHEETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLESHEETS" + } + }, + "GOOGLEANALYTICS4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLEANALYTICS4" + } + }, + "SERVICENOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICENOW" + } + }, + "MARKETO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MARKETO" + } + }, + "SAPODATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAPODATA" + } + }, + "ZENDESK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZENDESK" + } + }, + "JIRACLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRACLOUD" + } + }, + "NETSUITEERP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETSUITEERP" + } + }, + "HUBSPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HUBSPOT" + } + }, + "FACEBOOKADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACEBOOKADS" + } + }, + "INSTAGRAMADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTAGRAMADS" + } + }, + "ZOHOCRM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZOHOCRM" + } + }, + "SALESFORCEPARDOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCEPARDOT" + } + }, + "SALESFORCEMARKETINGCLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCEMARKETINGCLOUD" + } + }, + "SLACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLACK" + } + }, + "STRIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRIPE" + } + }, + "INTERCOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERCOM" + } + }, + "SNAPCHATADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPCHATADS" + } } } }, + "com.amazonaws.glue#ConnectionTypeBrief": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.glue#ConnectionType", + "traits": { + "smithy.api#documentation": "

The name of the connection type.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#Description", + "traits": { + "smithy.api#documentation": "

A description of the connection type.

" + } + }, + "Capabilities": { + "target": "com.amazonaws.glue#Capabilities", + "traits": { + "smithy.api#documentation": "

The supported authentication types, data interface types (compute environments), and data operations of the connector.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Brief information about a supported connection type returned by the ListConnectionTypes API.

" + } + }, + "com.amazonaws.glue#ConnectionTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ConnectionTypeBrief" + } + }, "com.amazonaws.glue#ConnectionsList": { "type": "structure", "members": { @@ -8319,6 +9137,88 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#CreateCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateCatalogRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederatedResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new catalog in the Glue Data Catalog.

" + } + }, + "com.amazonaws.glue#CreateCatalogRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#CatalogNameString", + "traits": { + "smithy.api#documentation": "

The name of the catalog to create.

", + "smithy.api#required": {} + } + }, + "CatalogInput": { + "target": "com.amazonaws.glue#CatalogInput", + "traits": { + "smithy.api#documentation": "

A CatalogInput object that defines the metadata for the catalog.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

A map array of key-value pairs, not more than 50 pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a UTF-8 string, not more than 256 bytes long. The tags you assign to the catalog.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateCatalogResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#CreateClassifier": { "type": "operation", "input": { @@ -8959,6 +9859,12 @@ { "target": "com.amazonaws.glue#FederatedResourceAlreadyExistsException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -9311,6 +10217,369 @@ "smithy.api#documentation": "

Specifies a grok classifier for CreateClassifier\n to create.

" } }, + "com.amazonaws.glue#CreateIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.glue#IntegrationQuotaExceededFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the SourceArn and TargetArn.

" + } + }, + "com.amazonaws.glue#CreateIntegrationRequest": { + "type": "structure", + "members": { + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A unique name for an integration in Glue.

", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the source resource for the integration.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the target resource for the integration.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of a KMS key used for encrypting the channel.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "

An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "

Metadata assigned to the resource consisting of a list of key-value pairs.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateIntegrationResourceProperty": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateIntegrationResourcePropertyRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateIntegrationResourcePropertyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API can be used for setting up the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue connection ARN as ResourceArn with SourceProcessingProperties and the Glue database ARN as ResourceArn with TargetProcessingProperties respectively.

" + } + }, + "com.amazonaws.glue#CreateIntegrationResourcePropertyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration source.

" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration target.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateIntegrationResourcePropertyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration source.

" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration target.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#CreateIntegrationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the source resource for the integration.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the target resource for the integration.

", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A unique name for an integration in Glue.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the created integration.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of a KMS key used for encrypting the channel.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "

An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "

Metadata assigned to the resource consisting of a list of key-value pairs.

" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The status of the integration being created.

\n

The possible statuses are:

\n ", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "com.amazonaws.glue#IntegrationTimestamp", + "traits": { + "smithy.api#documentation": "

The time when the integration was created, in UTC.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors associated with the integration creation.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#CreateIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.

" + } + }, + "com.amazonaws.glue#CreateIntegrationTablePropertiesRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The name of the table to be replicated.

", + "smithy.api#required": {} + } + }, + "SourceTableConfig": { + "target": "com.amazonaws.glue#SourceTableConfig", + "traits": { + "smithy.api#documentation": "

A structure for the source table configuration.

" + } + }, + "TargetTableConfig": { + "target": "com.amazonaws.glue#TargetTableConfig", + "traits": { + "smithy.api#documentation": "

A structure for the target table configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateIntegrationTablePropertiesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#CreateJob": { "type": "operation", "input": { @@ -10423,6 +11692,12 @@ { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -10974,6 +12249,36 @@ "com.amazonaws.glue#CreatedTimestamp": { "type": "string" }, + "com.amazonaws.glue#CredentialKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#CredentialMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#CredentialKey" + }, + "value": { + "target": "com.amazonaws.glue#CredentialValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#CredentialValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.glue#CronExpression": { "type": "string" }, @@ -11241,6 +12546,15 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, + "com.amazonaws.glue#CustomProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, "com.amazonaws.glue#DQAdditionalOptions": { "type": "map", "key": { @@ -11421,6 +12735,96 @@ } } }, + "com.amazonaws.glue#DataLakeAccessProperties": { + "type": "structure", + "members": { + "DataLakeAccess": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine, such as Amazon Athena, Amazon EMR, or Glue ETL.

" + } + }, + "DataTransferRole": { + "target": "com.amazonaws.glue#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.

" + } + }, + "KmsKey": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "

An encryption key that will be used for the staging bucket that will be created along with the catalog.

" + } + }, + "CatalogType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input properties to configure data lake access for your catalog resource in the Glue Data Catalog.

" + } + }, + "com.amazonaws.glue#DataLakeAccessPropertiesOutput": { + "type": "structure", + "members": { + "DataLakeAccess": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog.

" + } + }, + "DataTransferRole": { + "target": "com.amazonaws.glue#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.

" + } + }, + "KmsKey": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "

An encryption key that will be used for the staging bucket that will be created along with the catalog.

" + } + }, + "ManagedWorkgroupName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The managed Redshift Serverless compute name that is created for your catalog resource.

" + } + }, + "ManagedWorkgroupStatus": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The managed Redshift Serverless compute status.

" + } + }, + "RedshiftDatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The default Redshift database resource name in the managed compute.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A message that gives more detailed information about the managed workgroup status.

" + } + }, + "CatalogType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output properties of the data lake access configuration for your catalog resource in the Glue Data Catalog.

" + } + }, "com.amazonaws.glue#DataLakePrincipal": { "type": "structure", "members": { @@ -11444,6 +12848,29 @@ } } }, + "com.amazonaws.glue#DataOperation": { + "type": "enum", + "members": { + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE" + } + } + } + }, + "com.amazonaws.glue#DataOperations": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#DataOperation" + } + }, "com.amazonaws.glue#DataQualityAnalyzerResult": { "type": "structure", "members": { @@ -12606,6 +14033,66 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#DeleteCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteCatalogRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified catalog from the Glue Data Catalog.

\n

After completing this operation, you no longer have access to the databases, tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted catalog. Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources before calling the DeleteCatalog operation, use DeleteTableVersion (or BatchDeleteTableVersion), DeletePartition (or BatchDeletePartition), DeleteTable (or BatchDeleteTable), DeleteUserDefinedFunction and DeleteDatabase to delete any resources that belong to the catalog.

" + } + }, + "com.amazonaws.glue#DeleteCatalogRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the catalog.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteCatalogResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#DeleteClassifier": { "type": "operation", "input": { @@ -13078,6 +14565,12 @@ { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#InternalServiceException" }, @@ -13168,6 +14661,218 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#InvalidIntegrationStateFault" + }, + { + "target": "com.amazonaws.glue#InvalidStateException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified Zero-ETL integration.

" + } + }, + "com.amazonaws.glue#DeleteIntegrationRequest": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the integration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteIntegrationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the source for the integration.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the target for the integration.

", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A unique name for an integration in Glue.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the integration.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of a KMS key used for encrypting the channel.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "

An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "

Metadata assigned to the resource consisting of a list of key-value pairs.

" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The status of the integration being deleted.

\n

The possible statuses are:

\n ", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "com.amazonaws.glue#IntegrationTimestamp", + "traits": { + "smithy.api#documentation": "

The time when the integration was created, in UTC.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors associated with the integration.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DeleteIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the table properties that have been created for the tables that need to be replicated.

" + } + }, + "com.amazonaws.glue#DeleteIntegrationTablePropertiesRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The name of the table to be replicated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteIntegrationTablePropertiesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#DeleteJob": { "type": "operation", "input": { @@ -13799,6 +15504,12 @@ { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#InternalServiceException" }, @@ -14271,6 +15982,410 @@ "target": "com.amazonaws.glue#DeltaTarget" } }, + "com.amazonaws.glue#DescribeConnectionType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeConnectionTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeConnectionTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The DescribeConnectionType API provides full details of the supported options for a given connection type in Glue.

" + } + }, + "com.amazonaws.glue#DescribeConnectionTypeRequest": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the connection type to be described.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeConnectionTypeResponse": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the connection type.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#Description", + "traits": { + "smithy.api#documentation": "

A description of the connection type.

" + } + }, + "Capabilities": { + "target": "com.amazonaws.glue#Capabilities", + "traits": { + "smithy.api#documentation": "

The supported authentication types, data interface types (compute environments), and data operations of the connector.

" + } + }, + "ConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

Connection properties which are common across compute environments.

" + } + }, + "ConnectionOptions": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

Returns properties that can be set when creating a connection in the ConnectionInput.ConnectionProperties. ConnectionOptions defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.

" + } + }, + "AuthenticationConfiguration": { + "target": "com.amazonaws.glue#AuthConfiguration", + "traits": { + "smithy.api#documentation": "

The type of authentication used for the connection.

" + } + }, + "ComputeEnvironmentConfigurations": { + "target": "com.amazonaws.glue#ComputeEnvironmentConfigurationMap", + "traits": { + "smithy.api#documentation": "

The compute environments that are supported by the connection.

" + } + }, + "PhysicalConnectionRequirements": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.

" + } + }, + "AthenaConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

Connection properties specific to the Athena compute environment.

" + } + }, + "PythonConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

Connection properties specific to the Python compute environment.

" + } + }, + "SparkConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "

Connection properties specific to the Spark compute environment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DescribeEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeEntityRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.

\n

The response includes all the fields which make up the entity.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Fields" + } + } + }, + "com.amazonaws.glue#DescribeEntityRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the connection that contains the connection type credentials.

", + "smithy.api#required": {} + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

" + } + }, + "EntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the entity that you want to describe from the connection type.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, included if this is a continuation call.

" + } + }, + "DataStoreApiVersion": { + "target": "com.amazonaws.glue#ApiVersion", + "traits": { + "smithy.api#documentation": "

The version of the API used for the data store.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeEntityResponse": { + "type": "structure", + "members": { + "Fields": { + "target": "com.amazonaws.glue#FieldsList", + "traits": { + "smithy.api#documentation": "

Describes the fields for that connector entity. This is the list of Field objects. Field is very similar to column in a database. The Field object has information about different properties associated with fields in the connector.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, present if the current segment is not the last.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DescribeInboundIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeInboundIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeInboundIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.glue#TargetResourceNotFound" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of inbound integrations for the specified integration.

" + } + }, + "com.amazonaws.glue#DescribeInboundIntegrationsRequest": { + "type": "structure", + "members": { + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integration.

" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the marker from a previously truncated response.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.glue#IntegrationInteger", + "traits": { + "smithy.api#documentation": "

The total number of items to return in the output.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target resource in the integration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeInboundIntegrationsResponse": { + "type": "structure", + "members": { + "InboundIntegrations": { + "target": "com.amazonaws.glue#InboundIntegrationsList", + "traits": { + "smithy.api#documentation": "

A list of inbound integrations.

" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A value that indicates the starting point for the next set of response records in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DescribeIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The API is used to retrieve a list of integrations.

" + } + }, + "com.amazonaws.glue#DescribeIntegrationsRequest": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the integration.

" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A value that indicates the starting point for the next set of response records in a subsequent request.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.glue#IntegrationInteger", + "traits": { + "smithy.api#documentation": "

The total number of items to return in the output.

" + } + }, + "Filters": { + "target": "com.amazonaws.glue#IntegrationFilterList", + "traits": { + "smithy.api#documentation": "

A list of key and values, to filter down the results. Supported keys are \"Status\", \"IntegrationName\", and \"SourceArn\". IntegrationName is limited to only one value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeIntegrationsResponse": { + "type": "structure", + "members": { + "Integrations": { + "target": "com.amazonaws.glue#IntegrationsList", + "traits": { + "smithy.api#documentation": "

A list of zero-ETL integrations.

" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A value that indicates the starting point for the next set of response records in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.glue#DescriptionString": { "type": "string", "traits": { @@ -15043,6 +17158,68 @@ "smithy.api#documentation": "

Specifies an encryption configuration.

" } }, + "com.amazonaws.glue#Entity": { + "type": "structure", + "members": { + "EntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the entity.

" + } + }, + "Label": { + "target": "com.amazonaws.glue#EntityLabel", + "traits": { + "smithy.api#documentation": "

Label used for the entity.

" + } + }, + "IsParentEntity": { + "target": "com.amazonaws.glue#IsParentEntity", + "traits": { + "smithy.api#documentation": "

A Boolean value which helps to determine whether there are sub objects that can be listed.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the entity.

" + } + }, + "Category": { + "target": "com.amazonaws.glue#Category", + "traits": { + "smithy.api#documentation": "

The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.

" + } + }, + "CustomProperties": { + "target": "com.amazonaws.glue#CustomProperties", + "traits": { + "smithy.api#documentation": "

An optional map of keys which may be returned for an entity by a connector.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An entity supported by a given ConnectionType.

" + } + }, + "com.amazonaws.glue#EntityDescription": { + "type": "string" + }, + "com.amazonaws.glue#EntityFieldName": { + "type": "string" + }, + "com.amazonaws.glue#EntityLabel": { + "type": "string" + }, + "com.amazonaws.glue#EntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Entity" + } + }, + "com.amazonaws.glue#EntityName": { + "type": "string" + }, "com.amazonaws.glue#EntityNotFoundException": { "type": "structure", "members": { @@ -15279,6 +17456,38 @@ "com.amazonaws.glue#EventQueueArn": { "type": "string" }, + "com.amazonaws.glue#ExecutionAttempt": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.glue#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the last column statistics task run.

" + } + }, + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "

A task run ID for the last column statistics task run.

" + } + }, + "ExecutionTimestamp": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp when the last column statistics task run occurred.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

An error message associated with the last column statistics task run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A run attempt for a column statistics task run.

" + } + }, "com.amazonaws.glue#ExecutionClass": { "type": "enum", "members": { @@ -15317,6 +17526,23 @@ "smithy.api#documentation": "

An execution property of a job.

" } }, + "com.amazonaws.glue#ExecutionStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + } + } + }, "com.amazonaws.glue#ExecutionTime": { "type": "integer", "traits": { @@ -15366,6 +17592,26 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.glue#FederatedCatalog": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.glue#FederationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the federated catalog.

" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the connection to an external data source, for example a Redshift-federated catalog.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A catalog that points to an entity outside the Glue Data Catalog.

" + } + }, "com.amazonaws.glue#FederatedDatabase": { "type": "structure", "members": { @@ -15544,6 +17790,294 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#Field": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.glue#EntityFieldName", + "traits": { + "smithy.api#documentation": "

A unique identifier for the field.

" + } + }, + "Label": { + "target": "com.amazonaws.glue#FieldLabel", + "traits": { + "smithy.api#documentation": "

A readable label used for the field.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#FieldDescription", + "traits": { + "smithy.api#documentation": "

A description of the field.

" + } + }, + "FieldType": { + "target": "com.amazonaws.glue#FieldDataType", + "traits": { + "smithy.api#documentation": "

The type of data in the field.

" + } + }, + "IsPrimaryKey": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field can used as a primary key for the given entity.

" + } + }, + "IsNullable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field can be nullable or not.

" + } + }, + "IsRetrievable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.

" + } + }, + "IsFilterable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.

" + } + }, + "IsPartitionable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether a given field can be used in partitioning the query made to SaaS.

" + } + }, + "IsCreateable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field can be created as part of a destination write.

" + } + }, + "IsUpdateable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field can be updated as part of a destination write.

" + } + }, + "IsUpsertable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field can be upserted as part of a destination write.

" + } + }, + "IsDefaultOnCreate": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.

" + } + }, + "SupportedValues": { + "target": "com.amazonaws.glue#ListOfString", + "traits": { + "smithy.api#documentation": "

A list of supported values for the field.

" + } + }, + "SupportedFilterOperators": { + "target": "com.amazonaws.glue#FieldFilterOperatorsList", + "traits": { + "smithy.api#documentation": "

Indicates the support filter operators for this field.

" + } + }, + "ParentField": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A parent field name for a nested field.

" + } + }, + "NativeDataType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.

" + } + }, + "CustomProperties": { + "target": "com.amazonaws.glue#CustomProperties", + "traits": { + "smithy.api#documentation": "

Optional map of keys which may be returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Field object has information about the different properties associated with a field in the connector.

" + } + }, + "com.amazonaws.glue#FieldDataType": { + "type": "enum", + "members": { + "INT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INT" + } + }, + "SMALLINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALLINT" + } + }, + "BIGINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGINT" + } + }, + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT" + } + }, + "LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONG" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "MAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAP" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARRAY" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "BYTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE" + } + }, + "SHORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHORT" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE" + } + }, + "STRUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRUCT" + } + } + } + }, + "com.amazonaws.glue#FieldDescription": { + "type": "string" + }, + "com.amazonaws.glue#FieldFilterOperator": { + "type": "enum", + "members": { + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + }, + "BETWEEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BETWEEN" + } + }, + "EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUAL_TO" + } + }, + "NOT_EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUAL_TO" + } + }, + "GREATER_THAN_OR_EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUAL_TO" + } + }, + "LESS_THAN_OR_EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN_OR_EQUAL_TO" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "ORDER_BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORDER_BY" + } + } + } + }, + "com.amazonaws.glue#FieldFilterOperatorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#FieldFilterOperator" + } + }, + "com.amazonaws.glue#FieldLabel": { + "type": "string" + }, "com.amazonaws.glue#FieldName": { "type": "enum", "members": { @@ -15582,6 +18116,12 @@ "com.amazonaws.glue#FieldType": { "type": "string" }, + "com.amazonaws.glue#FieldsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Field" + } + }, "com.amazonaws.glue#FillMissingValues": { "type": "structure", "members": { @@ -15792,6 +18332,15 @@ } } }, + "com.amazonaws.glue#FilterPredicate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + }, "com.amazonaws.glue#FilterString": { "type": "string", "traits": { @@ -16199,6 +18748,44 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetCatalogRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

The name of the Catalog to retrieve. This should be all lowercase.

" + } + }, "com.amazonaws.glue#GetCatalogImportStatus": { "type": "operation", "input": { @@ -16260,6 +18847,127 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetCatalogRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetCatalogResponse": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.glue#Catalog", + "traits": { + "smithy.api#documentation": "

A Catalog object. The definition of the specified catalog in the Glue Data Catalog.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#GetCatalogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetCatalogsRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetCatalogsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.

" + } + }, + "com.amazonaws.glue#GetCatalogsRequest": { + "type": "structure", + "members": { + "ParentCatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of catalogs to return in one response.

" + } + }, + "Recursive": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When specified as true, iterates through the account and returns all catalog resources (including top-level resources and child resources)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetCatalogsResponse": { + "type": "structure", + "members": { + "CatalogList": { + "target": "com.amazonaws.glue#CatalogList", + "traits": { + "smithy.api#documentation": "

An array of Catalog objects. A list of Catalog objects from the specified parent catalog.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetClassifier": { "type": "operation", "input": { @@ -16793,6 +19501,12 @@ "smithy.api#default": false, "smithy.api#documentation": "

Allows you to retrieve the connection metadata without returning the password. For\n instance, the Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.

" } + }, + "ApplyOverrideForComputeEnvironment": { + "target": "com.amazonaws.glue#ComputeEnvironment", + "traits": { + "smithy.api#documentation": "

For connections that may be used in multiple services, specifies returning properties for the specified compute environment.

" + } } }, "traits": { @@ -16858,6 +19572,12 @@ "traits": { "smithy.api#documentation": "

The type of connections to return. Currently, SFTP is not supported.

" } + }, + "ConnectionSchemaVersion": { + "target": "com.amazonaws.glue#ConnectionSchemaVersion", + "traits": { + "smithy.api#documentation": "

Denotes if the connection was created with schema version 1 or 2.

" + } } }, "traits": { @@ -17889,6 +20609,9 @@ { "target": "com.amazonaws.glue#FederationSourceException" }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -17950,6 +20673,15 @@ "target": "com.amazonaws.glue#GetDatabasesResponse" }, "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -18214,6 +20946,296 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetEntityRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetEntityRecordsRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetEntityRecordsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog.

\n

Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the DescribeEntity API.

\n

Spark connectors generate schemas according to the same data type mapping as in the DescribeEntity API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.

" + } + }, + "com.amazonaws.glue#GetEntityRecordsRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the connection that contains the connection type credentials.

" + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

" + } + }, + "EntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "

Name of the entity that we want to query the preview data from the given connection type.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, included if this is a continuation call.

" + } + }, + "DataStoreApiVersion": { + "target": "com.amazonaws.glue#ApiVersion", + "traits": { + "smithy.api#documentation": "

The API version of the SaaS connector.

" + } + }, + "ConnectionOptions": { + "target": "com.amazonaws.glue#ConnectionOptions", + "traits": { + "smithy.api#documentation": "

Connector options that are required to query the data.

" + } + }, + "FilterPredicate": { + "target": "com.amazonaws.glue#FilterPredicate", + "traits": { + "smithy.api#documentation": "

A filter predicate that you can apply in the query request.

" + } + }, + "Limit": { + "target": "com.amazonaws.glue#Limit", + "traits": { + "smithy.api#documentation": "

Limits the number of records fetched with the request.

", + "smithy.api#required": {} + } + }, + "OrderBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A parameter that orders the response preview data.

" + } + }, + "SelectedFields": { + "target": "com.amazonaws.glue#SelectedFields", + "traits": { + "smithy.api#documentation": "

List of fields that we want to fetch as part of preview data.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetEntityRecordsResponse": { + "type": "structure", + "members": { + "Records": { + "target": "com.amazonaws.glue#Records", + "traits": { + "smithy.api#documentation": "

A list of the requested objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, present if the current segment is not the last.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#GetIntegrationResourceProperty": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetIntegrationResourcePropertyRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetIntegrationResourcePropertyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is used for fetching the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target)

" + } + }, + "com.amazonaws.glue#GetIntegrationResourcePropertyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetIntegrationResourcePropertyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

" + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration source.

" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration target.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#GetIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.

" + } + }, + "com.amazonaws.glue#GetIntegrationTablePropertiesRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The name of the table to be replicated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetIntegrationTablePropertiesResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

" + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The name of the table to be replicated.

" + } + }, + "SourceTableConfig": { + "target": "com.amazonaws.glue#SourceTableConfig", + "traits": { + "smithy.api#documentation": "

A structure for the source table configuration.

" + } + }, + "TargetTableConfig": { + "target": "com.amazonaws.glue#TargetTableConfig", + "traits": { + "smithy.api#documentation": "

A structure for the target table configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetJob": { "type": "operation", "input": { @@ -22143,7 +25165,7 @@ "min": 1, "max": 10240 }, - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):glue:" + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:" } }, "com.amazonaws.glue#GlueSchema": { @@ -22283,7 +25305,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^\\w+\\.\\w+$" + "smithy.api#pattern": "^(\\w+\\.)+\\w+$" } }, "com.amazonaws.glue#GovernedCatalogSource": { @@ -22870,6 +25892,61 @@ "smithy.api#documentation": "

Specifies configuration properties for an importing labels task run.

" } }, + "com.amazonaws.glue#InboundIntegration": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the source resource for the integration.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the target resource for the integration.

", + "smithy.api#required": {} + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the zero-ETL integration.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The possible statuses are:

\n ", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "com.amazonaws.glue#IntegrationTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the integration was created, in UTC.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors associated with the integration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure for an integration that writes data into a resource.

" + } + }, + "com.amazonaws.glue#InboundIntegrationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#InboundIntegration" + } + }, "com.amazonaws.glue#InclusionAnnotationList": { "type": "list", "member": { @@ -22915,6 +25992,330 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#Integration": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN for the source of the integration.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN for the target of the integration.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description for the integration.

" + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A unique name for the integration.

", + "smithy.api#required": {} + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the integration.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of a KMS key used for encrypting the channel.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "

An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "

Metadata assigned to the resource consisting of a list of key-value pairs.

" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The possible statuses are:

\n ", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "com.amazonaws.glue#IntegrationTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the integration was created, in UTC.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors associated with the integration.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a zero-ETL integration.

" + } + }, + "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#IntegrationString" + }, + "value": { + "target": "com.amazonaws.glue#IntegrationString" + } + }, + "com.amazonaws.glue#IntegrationConflictOperationFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The requested operation conflicts with another operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.glue#IntegrationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.glue#IntegrationError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The code associated with this error.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

A message describing the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An error associated with a zero-ETL integration.

" + } + }, + "com.amazonaws.glue#IntegrationErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#IntegrationError" + } + }, + "com.amazonaws.glue#IntegrationErrorMessage": { + "type": "string" + }, + "com.amazonaws.glue#IntegrationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The name of the filter.

" + } + }, + "Values": { + "target": "com.amazonaws.glue#IntegrationFilterValues", + "traits": { + "smithy.api#documentation": "

A list of filter values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that can be used when invoking a DescribeIntegrations request.

" + } + }, + "com.amazonaws.glue#IntegrationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#IntegrationFilter" + } + }, + "com.amazonaws.glue#IntegrationFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#String128" + } + }, + "com.amazonaws.glue#IntegrationInteger": { + "type": "integer" + }, + "com.amazonaws.glue#IntegrationNotFoundFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified integration could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.glue#IntegrationPartition": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The field name used to partition data on the target.

" + } + }, + "FunctionSpec": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

Specifies a function used to partition data on the target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes how data is partitioned on the target.

" + } + }, + "com.amazonaws.glue#IntegrationPartitionSpecList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#IntegrationPartition" + } + }, + "com.amazonaws.glue#IntegrationQuotaExceededFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data processed through your integration exceeded your quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.glue#IntegrationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFYING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "SYNCING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCING" + } + }, + "NEEDS_ATTENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEEDS_ATTENTION" + } + } + } + }, + "com.amazonaws.glue#IntegrationString": { + "type": "string" + }, + "com.amazonaws.glue#IntegrationTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Tag" + } + }, + "com.amazonaws.glue#IntegrationTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.glue#IntegrationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Integration" + } + }, + "com.amazonaws.glue#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An internal server error occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, "com.amazonaws.glue#InternalServiceException": { "type": "structure", "members": { @@ -22951,6 +26352,22 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#InvalidIntegrationStateFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The integration is in an invalid state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.glue#InvalidStateException": { "type": "structure", "members": { @@ -22966,6 +26383,9 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#IsParentEntity": { + "type": "boolean" + }, "com.amazonaws.glue#IsVersionValid": { "type": "boolean", "traits": { @@ -24411,6 +27831,33 @@ "com.amazonaws.glue#JsonValue": { "type": "string" }, + "com.amazonaws.glue#JwtToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8000 + }, + "smithy.api#pattern": "^([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_\\-\\+\\/=]*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#KMSKeyNotAccessibleFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The KMS key specified is not accessible.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.glue#KafkaStreamingSourceOptions": { "type": "structure", "members": { @@ -24895,6 +28342,15 @@ "smithy.api#default": false } }, + "com.amazonaws.glue#Limit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.glue#LimitedPathList": { "type": "list", "member": { @@ -25058,6 +28514,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListConnectionTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListConnectionTypesRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListConnectionTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

The ListConnectionTypes API provides a discovery mechanism to learn available connection types in Glue. The response contains a list of connection types with high-level details of what is supported for each connection type. The connection types listed are the set of supported options for the ConnectionType value in the CreateConnection API.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ConnectionTypes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListConnectionTypesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.glue#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ListConnectionTypesResponse": { + "type": "structure", + "members": { + "ConnectionTypes": { + "target": "com.amazonaws.glue#ConnectionTypeList", + "traits": { + "smithy.api#documentation": "

A list of ConnectionTypeBrief objects containing brief information about the supported connection types.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, if the current list segment is not the last.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#ListCrawlers": { "type": "operation", "input": { @@ -25818,6 +29340,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the available entities supported by the connection type.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entities" + } + } + }, + "com.amazonaws.glue#ListEntitiesRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A name for the connection that has required credentials to query any connection type.

" + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

" + } + }, + "ParentEntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "

Name of the parent entity for which you want to list the children. This parameter takes a fully-qualified path of the entity in order to list the child entities.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, included if this is a continuation call.

" + } + }, + "DataStoreApiVersion": { + "target": "com.amazonaws.glue#ApiVersion", + "traits": { + "smithy.api#documentation": "

The API version of the SaaS connector.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ListEntitiesResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.glue#EntityList", + "traits": { + "smithy.api#documentation": "

A list of Entity objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "

A continuation token, present if the current segment is not the last.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#ListJobs": { "type": "operation", "input": { @@ -25986,6 +29606,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListOfString": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.glue#ListRegistries": { "type": "operation", "input": { @@ -27233,6 +30859,15 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.glue#MaxResultsNumber": { "type": "integer", "traits": { @@ -27492,6 +31127,172 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#ModifyIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ModifyIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.glue#ModifyIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#InvalidIntegrationStateFault" + }, + { + "target": "com.amazonaws.glue#InvalidStateException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies a Zero-ETL integration in the caller's account.

" + } + }, + "com.amazonaws.glue#ModifyIntegrationRequest": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the integration.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A unique name for an integration in Glue.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ModifyIntegrationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the source for the integration.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The ARN of the target for the integration.

", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A unique name for an integration in Glue.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the integration.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of a KMS key used for encrypting the channel.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "

An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "

Metadata assigned to the resource consisting of a list of key-value pairs.

" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The status of the integration being modified.

\n

The possible statuses are:

\n ", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "com.amazonaws.glue#IntegrationTimestamp", + "traits": { + "smithy.api#documentation": "

The time when the integration was created, in UTC.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors associated with the integration modification.

" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#MongoDBTarget": { "type": "structure", "members": { @@ -27611,6 +31412,16 @@ "target": "com.amazonaws.glue#NameString" } }, + "com.amazonaws.glue#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9+=/:_]*$" + } + }, "com.amazonaws.glue#NoScheduleException": { "type": "structure", "members": { @@ -27867,6 +31678,38 @@ "smithy.api#documentation": "

The OAuth2 client app used for the connection.

" } }, + "com.amazonaws.glue#OAuth2Credentials": { + "type": "structure", + "members": { + "UserManagedClientApplicationClientSecret": { + "target": "com.amazonaws.glue#UserManagedClientApplicationClientSecret", + "traits": { + "smithy.api#documentation": "

The client application client secret if the client application is user managed.

" + } + }, + "AccessToken": { + "target": "com.amazonaws.glue#AccessToken", + "traits": { + "smithy.api#documentation": "

The access token used when the authentication type is OAuth2.

" + } + }, + "RefreshToken": { + "target": "com.amazonaws.glue#RefreshToken", + "traits": { + "smithy.api#documentation": "

The refresh token used when the authentication type is OAuth2.

" + } + }, + "JwtToken": { + "target": "com.amazonaws.glue#JwtToken", + "traits": { + "smithy.api#documentation": "

The JSON Web Token (JWT) used when the authentication type is OAuth2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The credentials used when the authentication type is OAuth2 authentication.

" + } + }, "com.amazonaws.glue#OAuth2GrantType": { "type": "enum", "members": { @@ -27954,6 +31797,12 @@ "traits": { "smithy.api#documentation": "

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

" } + }, + "OAuth2Credentials": { + "target": "com.amazonaws.glue#OAuth2Credentials", + "traits": { + "smithy.api#documentation": "

The credentials used when the authentication type is OAuth2 authentication.

" + } } }, "traits": { @@ -28052,12 +31901,32 @@ "smithy.api#documentation": "

Specifies an option value.

" } }, + "com.amazonaws.glue#OptionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\w]*$" + } + }, "com.amazonaws.glue#OptionList": { "type": "list", "member": { "target": "com.amazonaws.glue#Option" } }, + "com.amazonaws.glue#OptionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\S]*$" + } + }, "com.amazonaws.glue#OracleSQLCatalogSource": { "type": "structure", "members": { @@ -28785,6 +32654,17 @@ "smithy.api#documentation": "

Contains a list of values defining partitions.

" } }, + "com.amazonaws.glue#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.glue#Path": { "type": "string" }, @@ -29124,6 +33004,12 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, + "com.amazonaws.glue#PrimaryKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#String128" + } + }, "com.amazonaws.glue#PrincipalPermissions": { "type": "structure", "members": { @@ -29202,6 +33088,79 @@ "smithy.api#documentation": "

Specifies the job and session values that an admin configures in an Glue usage profile.

" } }, + "com.amazonaws.glue#PropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#PropertyName" + }, + "value": { + "target": "com.amazonaws.glue#Property" + } + }, + "com.amazonaws.glue#Property": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#PropertyName", + "traits": { + "smithy.api#documentation": "

The name of the property.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#PropertyDescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the property.

", + "smithy.api#required": {} + } + }, + "Required": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "

Indicates whether the property is required.

", + "smithy.api#required": {} + } + }, + "DefaultValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The default value for the property.

" + } + }, + "PropertyTypes": { + "target": "com.amazonaws.glue#PropertyTypes", + "traits": { + "smithy.api#default": [], + "smithy.api#documentation": "

Describes the type of property.

", + "smithy.api#required": {} + } + }, + "AllowedValues": { + "target": "com.amazonaws.glue#AllowedValues", + "traits": { + "smithy.api#documentation": "

A list of AllowedValue objects representing the values allowed for the property.

" + } + }, + "DataOperationScopes": { + "target": "com.amazonaws.glue#DataOperations", + "traits": { + "smithy.api#documentation": "

Indicates which data operations are applicable to the property.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that defines a connection type for a compute environment.

" + } + }, + "com.amazonaws.glue#PropertyDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.glue#PropertyKey": { "type": "string", "traits": { @@ -29220,6 +33179,24 @@ "target": "com.amazonaws.glue#PropertyValue" } }, + "com.amazonaws.glue#PropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#PropertyNameOverrides": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#PropertyName" + }, + "value": { + "target": "com.amazonaws.glue#PropertyName" + } + }, "com.amazonaws.glue#PropertyPredicate": { "type": "structure", "members": { @@ -29246,6 +33223,47 @@ "smithy.api#documentation": "

Defines a property predicate.

" } }, + "com.amazonaws.glue#PropertyType": { + "type": "enum", + "members": { + "USER_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_INPUT" + } + }, + "SECRET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRET" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + }, + "UNUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNUSED" + } + }, + "SECRET_OR_USER_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRET_OR_USER_INPUT" + } + } + } + }, + "com.amazonaws.glue#PropertyTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#PropertyType" + } + }, "com.amazonaws.glue#PropertyValue": { "type": "string", "traits": { @@ -29934,6 +33952,21 @@ } } }, + "com.amazonaws.glue#Record": { + "type": "document", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#Records": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Record" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.glue#RecordsCount": { "type": "long" }, @@ -30085,6 +34118,17 @@ "target": "com.amazonaws.glue#NameString" } }, + "com.amazonaws.glue#RefreshToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.glue#RegisterSchemaVersion": { "type": "operation", "input": { @@ -30514,6 +34558,25 @@ } } }, + "com.amazonaws.glue#ResourceArnString": { + "type": "string" + }, + "com.amazonaws.glue#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.glue#ResourceNotReadyException": { "type": "structure", "members": { @@ -32021,6 +36084,23 @@ } } }, + "com.amazonaws.glue#ScheduleType": { + "type": "enum", + "members": { + "CRON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRON" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, "com.amazonaws.glue#SchedulerNotRunningException": { "type": "structure", "members": { @@ -32683,6 +36763,18 @@ "smithy.api#documentation": "

Specifies a transform that chooses one DynamicFrame from a collection of DynamicFrames. The output is the selected DynamicFrame\n

" } }, + "com.amazonaws.glue#SelectedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#EntityFieldName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.glue#Separator": { "type": "enum", "members": { @@ -32946,6 +37038,23 @@ } } }, + "com.amazonaws.glue#SettingSource": { + "type": "enum", + "members": { + "CATALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATALOG" + } + }, + "TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABLE" + } + } + } + }, "com.amazonaws.glue#SkewedInfo": { "type": "structure", "members": { @@ -33332,6 +37441,58 @@ } } }, + "com.amazonaws.glue#SourceProcessingProperties": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The IAM role to access the Glue connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration source.

" + } + }, + "com.amazonaws.glue#SourceTableConfig": { + "type": "structure", + "members": { + "Fields": { + "target": "com.amazonaws.glue#SourceTableFieldsList", + "traits": { + "smithy.api#documentation": "

A list of fields used for column-level filtering.

" + } + }, + "FilterPredicate": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

A condition clause used for row-level filtering.

" + } + }, + "PrimaryKey": { + "target": "com.amazonaws.glue#PrimaryKeyList", + "traits": { + "smithy.api#documentation": "

Unique identifier of a record.

" + } + }, + "RecordUpdateField": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

Incremental pull timestamp-based field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties used by the source leg to process data from the source.

" + } + }, + "com.amazonaws.glue#SourceTableFieldsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#String128" + } + }, "com.amazonaws.glue#SparkConnectorSource": { "type": "structure", "members": { @@ -35562,6 +39723,24 @@ "smithy.api#documentation": "

Specifies options related to data preview for viewing a sample of your data.

" } }, + "com.amazonaws.glue#String128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.glue#StringColumnStatisticsData": { "type": "structure", "members": { @@ -36288,6 +40467,26 @@ "target": "com.amazonaws.glue#TableVersionError" } }, + "com.amazonaws.glue#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.glue#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.

" + } + }, + "value": { + "target": "com.amazonaws.glue#TagValue", + "traits": { + "smithy.api#documentation": "

The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Tag object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

\n

For more information about tags, and controlling access to resources in Glue, see\n Amazon Web Services Tags in Glue and Specifying Glue Resource\n ARNs in the developer guide.

" + } + }, "com.amazonaws.glue#TagKey": { "type": "string", "traits": { @@ -36444,6 +40643,95 @@ } } }, + "com.amazonaws.glue#TargetProcessingProperties": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The IAM role to access the Glue database.

" + } + }, + "KmsArn": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key used for encryption.

" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The Glue network connection to configure the Glue job running in the customer VPC.

" + } + }, + "EventBusArn": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of an Eventbridge event bus to receive the integration status notification.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration target.

" + } + }, + "com.amazonaws.glue#TargetRedshiftCatalog": { + "type": "structure", + "members": { + "CatalogArn": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the catalog resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes a target catalog for resource linking.

" + } + }, + "com.amazonaws.glue#TargetResourceNotFound": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The target resource could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.glue#TargetTableConfig": { + "type": "structure", + "members": { + "UnnestSpec": { + "target": "com.amazonaws.glue#UnnestSpec", + "traits": { + "smithy.api#documentation": "

Specifies how nested objects are flattened to top-level elements. Valid values are: \"TOPLEVEL\", \"FULL\", or \"NOUNNEST\".

" + } + }, + "PartitionSpec": { + "target": "com.amazonaws.glue#IntegrationPartitionSpecList", + "traits": { + "smithy.api#documentation": "

Determines the file layout on the target.

" + } + }, + "TargetTableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The optional name of a target table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties used by the target leg to partition the data on the target.

" + } + }, "com.amazonaws.glue#TaskRun": { "type": "structure", "members": { @@ -36794,6 +41082,12 @@ "smithy.api#documentation": "

Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.

" } }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The catalog ID where the connection resides.

" + } + }, "TestConnectionInput": { "target": "com.amazonaws.glue#TestConnectionInput", "traits": { @@ -37556,6 +41850,29 @@ } } }, + "com.amazonaws.glue#UnnestSpec": { + "type": "enum", + "members": { + "TOPLEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPLEVEL" + } + }, + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL" + } + }, + "NOUNNEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOUNNEST" + } + } + } + }, "com.amazonaws.glue#UntagResource": { "type": "operation", "input": { @@ -37702,6 +42019,44 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#UpdateCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateCatalogRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing catalog's properties in the Glue Data Catalog.

" + } + }, "com.amazonaws.glue#UpdateCatalogBehavior": { "type": "enum", "members": { @@ -37719,6 +42074,35 @@ } } }, + "com.amazonaws.glue#UpdateCatalogRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the catalog.

", + "smithy.api#required": {} + } + }, + "CatalogInput": { + "target": "com.amazonaws.glue#CatalogInput", + "traits": { + "smithy.api#documentation": "

A CatalogInput object specifying the new properties of an existing catalog.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#UpdateCatalogResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#UpdateClassifier": { "type": "operation", "input": { @@ -38467,12 +42851,21 @@ "target": "com.amazonaws.glue#UpdateDatabaseResponse" }, "errors": [ + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, { "target": "com.amazonaws.glue#ConcurrentModificationException" }, { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -38652,6 +43045,170 @@ "smithy.api#documentation": "

Specifies a grok classifier to update when passed to\n UpdateClassifier.

" } }, + "com.amazonaws.glue#UpdateIntegrationResourceProperty": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateIntegrationResourcePropertyRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateIntegrationResourcePropertyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API can be used for updating the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource properties will impact all the integrations using it.

" + } + }, + "com.amazonaws.glue#UpdateIntegrationResourcePropertyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration source.

" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration target.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#UpdateIntegrationResourcePropertyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

" + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration source.

" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "

The resource properties associated with the integration target.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#UpdateIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.

\n

The override will be reflected across all the integrations using same ResourceArn and source table.

" + } + }, + "com.amazonaws.glue#UpdateIntegrationTablePropertiesRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The connection ARN of the source, or the database ARN of the target.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "

The name of the table to be replicated.

", + "smithy.api#required": {} + } + }, + "SourceTableConfig": { + "target": "com.amazonaws.glue#SourceTableConfig", + "traits": { + "smithy.api#documentation": "

A structure for the source table configuration.

" + } + }, + "TargetTableConfig": { + "target": "com.amazonaws.glue#TargetTableConfig", + "traits": { + "smithy.api#documentation": "

A structure for the target table configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#UpdateIntegrationTablePropertiesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#UpdateJob": { "type": "operation", "input": { @@ -39324,12 +43881,21 @@ "target": "com.amazonaws.glue#UpdateTableResponse" }, "errors": [ + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, { "target": "com.amazonaws.glue#ConcurrentModificationException" }, { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -39997,6 +44563,27 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.glue#UserManagedClientApplicationClientSecret": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.glue#ValidationException": { "type": "structure", "members": { @@ -40016,7 +44603,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 1024 } } diff --git a/codegen/sdk-codegen/aws-models/lakeformation.json b/codegen/sdk-codegen/aws-models/lakeformation.json index b9747fcf0ec..13bc932b2dc 100644 --- a/codegen/sdk-codegen/aws-models/lakeformation.json +++ b/codegen/sdk-codegen/aws-models/lakeformation.json @@ -1780,7 +1780,14 @@ }, "com.amazonaws.lakeformation#CatalogResource": { "type": "structure", - "members": {}, + "members": { + "Id": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "

An identifier for the catalog resource.

" + } + } + }, "traits": { "smithy.api#documentation": "

A structure for the catalog object.

" } @@ -1983,6 +1990,20 @@ "smithy.api#error": "client" } }, + "com.amazonaws.lakeformation#Condition": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.lakeformation#ExpressionString", + "traits": { + "smithy.api#documentation": "

An expression written based on the Cedar Policy Language used to match the principal attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.

" + } + }, "com.amazonaws.lakeformation#ContextKey": { "type": "string", "traits": { @@ -3529,6 +3550,15 @@ "target": "com.amazonaws.lakeformation#LFTag" } }, + "com.amazonaws.lakeformation#ExpressionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3000 + } + } + }, "com.amazonaws.lakeformation#ExtendTransaction": { "type": "operation", "input": { @@ -5359,6 +5389,12 @@ "Principal": { "target": "com.amazonaws.lakeformation#DataLakePrincipal" }, + "Condition": { + "target": "com.amazonaws.lakeformation#Condition", + "traits": { + "smithy.api#documentation": "

A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.

" + } + }, "LastModified": { "target": "com.amazonaws.lakeformation#LastModifiedTimestamp", "traits": { @@ -6365,6 +6401,18 @@ "traits": { "smithy.api#enumValue": "CREATE_LF_TAG_EXPRESSION" } + }, + "CREATE_CATALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_CATALOG" + } + }, + "SUPER_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPER_USER" + } } } }, @@ -6517,6 +6565,12 @@ "smithy.api#documentation": "

The resource where permissions are to be granted or revoked.

" } }, + "Condition": { + "target": "com.amazonaws.lakeformation#Condition", + "traits": { + "smithy.api#documentation": "

A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.

" + } + }, "Permissions": { "target": "com.amazonaws.lakeformation#PermissionList", "traits": { diff --git a/codegen/sdk-codegen/aws-models/qapps.json b/codegen/sdk-codegen/aws-models/qapps.json index a4923177d90..4a56bb3d546 100644 --- a/codegen/sdk-codegen/aws-models/qapps.json +++ b/codegen/sdk-codegen/aws-models/qapps.json @@ -34,6 +34,15 @@ } } }, + "com.amazonaws.qapps#ActionIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.qapps#AmazonResourceName": { "type": "string", "traits": { @@ -197,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a rating or review for a library item with the user submitting\n the request. This increments the rating count for the specified library item.

", + "smithy.api#documentation": "

Associates a rating or review for a library item with the user submitting the request.\n This increments the rating count for the specified library item.

", "smithy.api#examples": [ { "title": "Increase the rating counter by 1 for the related app for this user", @@ -268,7 +277,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation creates a link between the user's identity calling the operation and a\n specific Q App. This is useful to mark the Q App as a favorite for\n the user if the user doesn't own the Amazon Q App so they can still run it and see it in their\n inventory of Q Apps.

", + "smithy.api#documentation": "

This operation creates a link between the user's identity calling the operation and a\n specific Q App. This is useful to mark the Q App as a favorite for the\n user if the user doesn't own the Amazon Q App so they can still run it and see it in their\n inventory of Q Apps.

", "smithy.api#examples": [ { "title": "Links an Amazon Q App to the invoker's list of apps", @@ -331,48 +340,48 @@ "equalsTo": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata fields. Supported\n for the following document attribute value types: dateValue,\n longValue, stringListValue and\n stringValue.

" + "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue, longValue,\n stringListValue and stringValue.

" } }, "containsAll": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains all the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains all the specified document attributes\n or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "containsAny": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "greaterThan": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a greater than operation on two document attributes or\n metadata fields. Supported for the following document attribute value types: dateValue and\n longValue.

" } }, "greaterThanOrEquals": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than or equals operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a greater than or equals operation on two document\n attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.\n

" } }, "lessThan": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue and\n longValue.

" } }, "lessThanOrEquals": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes or metadata\n fields.Supported for the following document attribute value type: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes\n or metadata fields.Supported for the following document attribute value type: dateValue and longValue.\n

" } } }, "traits": { - "smithy.api#documentation": "

The filter criteria used on responses based on document attributes or metadata fields.

" + "smithy.api#documentation": "

The filter criteria used on responses based on document attributes or metadata\n fields.

" } }, "com.amazonaws.qapps#AttributeFilters": { @@ -413,7 +422,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Creates Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Creates the categories for the library", @@ -467,7 +476,7 @@ "id": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.

" + "smithy.api#documentation": "

The unique identifier to be associated with a category. If you don't include a value, the\n category is automatically assigned a unique identifier.

" } }, "title": { @@ -485,7 +494,7 @@ "color": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.

", + "smithy.api#documentation": "

The color to be associated with a category. The color must be a hexadecimal value of\n either 3 or 6 digits.

", "smithy.api#length": { "min": 4, "max": 7 @@ -541,7 +550,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Deletes Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Deletes the categories in the library", @@ -614,7 +623,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Updates Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Updates the categories in the library", @@ -872,7 +881,7 @@ "submissionMutation": { "target": "com.amazonaws.qapps#SubmissionMutation", "traits": { - "smithy.api#documentation": "

The structure that describes how the current form card value is mutated.\n Only applies for form cards when multiple responses are allowed.

" + "smithy.api#documentation": "

The structure that describes how the current form card value is mutated. Only applies for\n form cards when multiple responses are allowed.

" } } }, @@ -972,7 +981,7 @@ "color": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The color of the category, represented as a hexadecimal value of either 3 or 6 digits.

", + "smithy.api#documentation": "

The color of the category, represented as a hexadecimal value of either 3 or 6\n digits.

", "smithy.api#length": { "min": 4, "max": 7 @@ -982,7 +991,7 @@ } }, "traits": { - "smithy.api#documentation": "

A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.

" + "smithy.api#documentation": "

A label that web experience users associate with a library item. Web experience users use\n Categories to tag and filter library items.

" } }, "com.amazonaws.qapps#CategoryList": { @@ -1032,7 +1041,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed due to a\n conflict with the current state of the resource.

", + "smithy.api#documentation": "

The requested operation could not be completed due to a conflict with the current state of\n the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1062,7 +1071,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because\n the content exceeds the maximum allowed size.

", + "smithy.api#documentation": "

The requested operation could not be completed because the content exceeds the maximum\n allowed size.

", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -1124,7 +1133,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new library item for an Amazon Q App, allowing it to be discovered and\n used by other allowed users.

", + "smithy.api#documentation": "

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by\n other allowed users.

", "smithy.api#examples": [ { "title": "Create a Library Item", @@ -1278,13 +1287,13 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a presigned URL for an S3 POST operation to upload a file.\n You can use this URL to set a default file for a FileUploadCard\n in a Q App definition or to provide a file for a single Q App run.\n The scope parameter determines how the file will be used,\n either at the app definition level or the app session level.

", + "smithy.api#documentation": "

Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to\n set a default file for a FileUploadCard in a Q App definition or to provide a\n file for a single Q App run. The scope parameter determines how the file will be\n used, either at the app definition level or the app session level.

", "smithy.api#examples": [ { "title": "Upload a file to a specific session", "input": { "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f", - "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=", + "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=", "fileName": "myFile.txt", "cardId": "82f69028-22a9-4bea-8727-0eabf58e9fed", "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0", @@ -1293,12 +1302,12 @@ }, "output": { "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4", - "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/", + "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/", "presignedUrlFields": { "x-amz-server-side-encryption": "aws:kms", "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f", - "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9", - "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=" + "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9", + "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=" }, "presignedUrlExpiration": "2024-09-14T00:11:54.232Z" } @@ -1307,7 +1316,7 @@ "title": "Upload a file into a application", "input": { "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f", - "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=", + "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=", "fileName": "anApplicationFile.txt", "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0", "cardId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e", @@ -1315,12 +1324,12 @@ }, "output": { "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4", - "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/", + "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/", "presignedUrlFields": { "x-amz-server-side-encryption": "aws:kms", "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f", - "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9", - "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=" + "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9", + "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=" }, "presignedUrlExpiration": "2024-09-14T00:11:54.232Z" } @@ -1375,14 +1384,14 @@ "scope": { "target": "com.amazonaws.qapps#DocumentScope", "traits": { - "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App session.

", + "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App\n session.

", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if applicable.

" + "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if\n applicable.

" } } }, @@ -1410,7 +1419,7 @@ "presignedUrlFields": { "target": "com.amazonaws.qapps#PresignedUrlFields", "traits": { - "smithy.api#documentation": "

The form fields to include in the presigned S3 POST operation used to upload a file.

", + "smithy.api#documentation": "

The form fields to include in the presigned S3 POST operation used to upload a\n file.

", "smithy.api#required": {} } }, @@ -1461,7 +1470,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies\n the cards and flow of the Q App. This operation also calculates the dependencies between the cards\n by inspecting the references in the prompts.

", + "smithy.api#documentation": "

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies\n the cards and flow of the Q App. This operation also calculates the dependencies between the\n cards by inspecting the references in the prompts.

", "smithy.api#examples": [ { "title": "A basic application with 1 text input card and 1 output card", @@ -1635,7 +1644,7 @@ "requiredCapabilities": { "target": "com.amazonaws.qapps#AppRequiredCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party integrations.

" + "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party\n integrations.

" } } }, @@ -1694,7 +1703,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a library item for an Amazon Q App, removing it from the library\n so it can no longer be discovered or used by other users.

", + "smithy.api#documentation": "

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer\n be discovered or used by other users.

", "smithy.api#examples": [ { "title": "Delete a library item", @@ -1763,7 +1772,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

", + "smithy.api#documentation": "

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the\n library, it is also removed from the library.

", "smithy.api#examples": [ { "title": "Delete an Amazon Q App", @@ -1905,7 +1914,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are\n returned.

" } }, "appId": { @@ -2036,7 +2045,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a Q App from a user removing the user's access to run the\n Q App.

", + "smithy.api#documentation": "

Disassociates a Q App from a user removing the user's access to run the Q App.

", "smithy.api#examples": [ { "title": "Unlinks an Amazon Q App from the invoker's list of apps", @@ -2148,7 +2157,7 @@ "dateValue": { "target": "com.amazonaws.qapps#Timestamp", "traits": { - "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

\n

It's important for the time zone to be included in the ISO 8601 date-time format. For\n example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012\n at 12:30PM (plus 10 seconds) in Central European Time.

" + "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

\n

It's important for the time zone to be included in the ISO 8601\n date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601\n date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.\n

" } } }, @@ -2395,7 +2404,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a file upload card. It can optionally\n receive a filename and fileId to set a\n default file. If not received, the user must provide the file\n when the Q App runs.

" + "smithy.api#documentation": "

Represents a file upload card. It can optionally receive a filename and\n fileId to set a default file. If not received, the user must provide the file\n when the Q App runs.

" } }, "com.amazonaws.qapps#Filename": { @@ -2447,7 +2456,7 @@ "computeMode": { "target": "com.amazonaws.qapps#InputCardComputeMode", "traits": { - "smithy.api#documentation": "

The compute mode of the form input card.\n This property determines whether individual participants of a\n data collection session can submit multiple response or one response.\n A compute mode of append shall allow participants\n to submit the same form multiple times with different values.\n A compute mode of replacecode> shall overwrite\n the current value for each participant.

" + "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual\n participants of a data collection session can submit multiple response or one response. A\n compute mode of append shall allow participants to submit the same form multiple\n times with different values. A compute mode of replacecode> shall overwrite the\n current value for each participant.

" } } }, @@ -2490,7 +2499,7 @@ "computeMode": { "target": "com.amazonaws.qapps#InputCardComputeMode", "traits": { - "smithy.api#documentation": "

The compute mode of the form input card.\n This property determines whether individual participants of a\n data collection session can submit multiple response or one response.\n A compute mode of append shall allow participants\n to submit the same form multiple times with different values.\n A compute mode of replacecode> shall overwrite\n the current value for each participant.

" + "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual\n participants of a data collection session can submit multiple response or one response. A\n compute mode of append shall allow participants to submit the same form multiple\n times with different values. A compute mode of replacecode> shall overwrite the\n current value for each participant.

" } } }, @@ -2744,7 +2753,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

", + "smithy.api#documentation": "

Retrieves the full details of an Q App, including its definition specifying the cards and\n flow.

", "smithy.api#examples": [ { "title": "A basic application with 1 text input card and 1 output card", @@ -2909,7 +2918,7 @@ "requiredCapabilities": { "target": "com.amazonaws.qapps#AppRequiredCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party integrations.

" + "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party\n integrations.

" } }, "appDefinition": { @@ -3199,7 +3208,7 @@ "userIsHost": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the current user is the owner of the Q App data collection session.

" + "smithy.api#documentation": "

Indicates whether the current user is the owner of the Q App data collection\n session.

" } } }, @@ -3242,7 +3251,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uploads a file that can then be used either as a default in a\n FileUploadCard from Q App definition or as a file that\n is used inside a single Q App run. The purpose of the document is\n determined by a scope parameter that indicates whether it is at the\n app definition level or at the app session level.

", + "smithy.api#documentation": "

Uploads a file that can then be used either as a default in a FileUploadCard\n from Q App definition or as a file that is used inside a single Q App run. The purpose of\n the document is determined by a scope parameter that indicates whether it is at the app\n definition level or at the app session level.

", "smithy.api#examples": [ { "title": "Upload a file to a specific session", @@ -3322,14 +3331,14 @@ "scope": { "target": "com.amazonaws.qapps#DocumentScope", "traits": { - "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App session.

", + "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App\n session.

", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if applicable.

" + "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if\n applicable.

" } } }, @@ -3500,7 +3509,7 @@ } }, "traits": { - "smithy.api#documentation": "

A library item is a snapshot of an Amazon Q App\n that can be published so the users in their Amazon Q Apps library\n can discover it, clone it, and run it.

" + "smithy.api#documentation": "

A library item is a snapshot of an Amazon Q App that can be published so the users in their\n Amazon Q Apps library can discover it, clone it, and run it.

" } }, "com.amazonaws.qapps#LibraryItemStatus": { @@ -3549,7 +3558,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Lists the categories of a Amazon Q Business application environment instance. For more information, see\n Custom labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "List categories available for the library items in this instance", @@ -3640,7 +3649,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

", + "smithy.api#documentation": "

Lists the library items for Amazon Q Apps that are published and available for users in your\n Amazon Web Services account.

", "smithy.api#examples": [ { "title": "List at most 3 library items for this instance", @@ -3913,7 +3922,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon Q Apps owned by or associated with the user either because\n they created it or because they used it from the library in the past. The user\n identity is extracted from the credentials used to invoke this operation..

", + "smithy.api#documentation": "

Lists the Amazon Q Apps owned by or associated with the user either because they created it\n or because they used it from the library in the past. The user identity is extracted from the\n credentials used to invoke this operation..

", "smithy.api#examples": [ { "title": "List at most 3 Amazon Q Apps in an Q Business application", @@ -4307,6 +4316,72 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "ASANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASANA" + } + }, + "ATLASSIAN_CONFLUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATLASSIAN_CONFLUENCE" + } + }, + "GOOGLE_CALENDAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLE_CALENDAR" + } + }, + "JIRA_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRA_CLOUD" + } + }, + "MICROSOFT_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_EXCHANGE" + } + }, + "MICROSOFT_TEAMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_TEAMS" + } + }, + "PAGERDUTY_ADVANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGERDUTY_ADVANCE" + } + }, + "SALESFORCE_CRM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE_CRM" + } + }, + "SERVICENOW_NOW_PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICENOW_NOW_PLATFORM" + } + }, + "SMARTSHEET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMARTSHEET" + } + }, + "ZENDESK_SUITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZENDESK_SUITE" + } } } }, @@ -4335,7 +4410,7 @@ } }, "traits": { - "smithy.api#documentation": "

The definition of an Amazon Q App generated based on input such as a conversation\n or problem statement.

" + "smithy.api#documentation": "

The definition of an Amazon Q App generated based on input such as a conversation or problem\n statement.

" } }, "com.amazonaws.qapps#PredictQApp": { @@ -4364,7 +4439,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates an Amazon Q App definition based on either a conversation or\n a problem statement provided as input.The resulting app definition\n can be used to call CreateQApp. This API doesn't create\n Amazon Q Apps directly.

", + "smithy.api#documentation": "

Generates an Amazon Q App definition based on either a conversation or a problem statement\n provided as input.The resulting app definition can be used to call CreateQApp.\n This API doesn't create Amazon Q Apps directly.

", "smithy.api#http": { "method": "POST", "uri": "/apps.predictQApp" @@ -4388,7 +4463,7 @@ "options": { "target": "com.amazonaws.qapps#PredictQAppInputOptions", "traits": { - "smithy.api#documentation": "

The input to generate the Q App definition from, either a conversation or problem statement.

" + "smithy.api#documentation": "

The input to generate the Q App definition from, either a conversation or problem\n statement.

" } } }, @@ -4537,7 +4612,7 @@ } }, "traits": { - "smithy.api#documentation": "

The response collected for a Amazon Q App session.\n This container represents a single response to a Q App session.

" + "smithy.api#documentation": "

The response collected for a Amazon Q App session. This container represents a single\n response to a Q App session.

" } }, "com.amazonaws.qapps#QAppSessionDataList": { @@ -4666,7 +4741,7 @@ "name": "qapps" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Q Apps feature capability within Amazon Q Business allows web experience\n users to create lightweight, purpose-built AI apps to fulfill specific tasks from\n within their web experience. For example, users can create a Q App that exclusively\n generates marketing-related content to improve your marketing team's productivity or a\n Q App for writing customer emails and creating promotional content using a certain\n style of voice, tone, and branding. For more information on the capabilities, see\n Amazon Q Apps capabilities in the Amazon Q Business User Guide.\n

\n

For an overview of the Amazon Q App APIs, see Overview of\n Amazon Q Apps API operations.

\n

For information about the IAM access control permissions you need to\n use the Amazon Q Apps API, see \n IAM role for the Amazon Q Business web experience including Amazon Q Apps in the\n Amazon Q Business User Guide.

", + "smithy.api#documentation": "

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create\n lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.\n For example, users can create a Q App that exclusively generates marketing-related content to\n improve your marketing team's productivity or a Q App for writing customer emails and\n creating promotional content using a certain style of voice, tone, and branding. For more\n information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User\n Guide.

\n

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API\n operations.

\n

For information about the IAM access control permissions you need to use\n the Amazon Q Apps API, see \n IAM role for the Amazon Q Business web experience including Amazon Q Apps in\n the Amazon Q Business User Guide.

", "smithy.api#title": "QApps", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5391,6 +5466,12 @@ "smithy.api#documentation": "

The unique identifier of the plugin used by the card.

", "smithy.api#required": {} } + }, + "actionIdentifier": { + "target": "com.amazonaws.qapps#ActionIdentifier", + "traits": { + "smithy.api#documentation": "

The action identifier of the action to be performed by the plugin card.

" + } } }, "traits": { @@ -5435,6 +5516,12 @@ "smithy.api#documentation": "

The unique identifier of the plugin used by the card.

", "smithy.api#required": {} } + }, + "actionIdentifier": { + "target": "com.amazonaws.qapps#ActionIdentifier", + "traits": { + "smithy.api#documentation": "

The action identifier of the action to be performed by the plugin card.

" + } } }, "traits": { @@ -5495,12 +5582,12 @@ "memoryReferences": { "target": "com.amazonaws.qapps#MemoryReferenceList", "traits": { - "smithy.api#documentation": "

Any dependencies for the query card, where the dependencies are references to the collected responses.

" + "smithy.api#documentation": "

Any dependencies for the query card, where the dependencies are references to the\n collected responses.

" } } }, "traits": { - "smithy.api#documentation": "

A card in a Amazon Q App that generates a response\n based on the Amazon Q Business service.

" + "smithy.api#documentation": "

A card in a Amazon Q App that generates a response based on the Amazon Q Business service.

" } }, "com.amazonaws.qapps#QQueryCardInput": { @@ -5639,7 +5726,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because\n it would exceed the service's quota or limit.

", + "smithy.api#documentation": "

The requested operation could not be completed because it would exceed the service's quota\n or limit.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -5674,7 +5761,7 @@ "revealCards": { "target": "com.amazonaws.qapps#SessionSharingRevealCards", "traits": { - "smithy.api#documentation": "

Indicates whether collected responses for an Q App session are revealed for all users.

" + "smithy.api#documentation": "

Indicates whether collected responses for an Q App session are revealed for all\n users.

" } } }, @@ -5720,7 +5807,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new session for an Amazon Q App, allowing inputs to be provided\n and the app to be run.

\n \n

Each Q App session will be condensed into a single conversation\n in the web experience.

\n ", + "smithy.api#documentation": "

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be\n run.

\n \n

Each Q App session will be condensed into a single conversation in the web\n experience.

\n ", "smithy.api#examples": [ { "title": "Start a session for an Amazon Q App using version 1, passing in initial values for one card", @@ -5849,7 +5936,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an active session for an Amazon Q App.This deletes all data\n related to the session and makes it invalid for future uses. The\n results of the session will be persisted as part of the conversation.

", + "smithy.api#documentation": "

Stops an active session for an Amazon Q App.This deletes all data related to the session and\n makes it invalid for future uses. The results of the session will be persisted as part of the\n conversation.

", "smithy.api#http": { "method": "POST", "uri": "/runtime.deleteMiniAppRun" @@ -6208,7 +6295,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because too many\n requests were sent at once. Wait a bit and try again later.

", + "smithy.api#documentation": "

The requested operation could not be completed because too many requests were sent at\n once. Wait a bit and try again later.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -6644,7 +6731,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

", + "smithy.api#documentation": "

Updates an existing Amazon Q App, allowing modifications to its title, description, and\n definition.

", "smithy.api#examples": [ { "title": "Updating the title of an app", @@ -6984,7 +7071,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were\n updated.

" } }, "appId": { @@ -7036,7 +7123,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the session for a given Q App sessionId. This is only\n valid when at least one card of the session is in the WAITING state.\n Data for each WAITING card can be provided as input. If inputs\n are not provided, the call will be accepted but session will not move forward.\n Inputs for cards that are not in the WAITING status will be ignored.

", + "smithy.api#documentation": "

Updates the session for a given Q App sessionId. This is only valid when at\n least one card of the session is in the WAITING state. Data for each\n WAITING card can be provided as input. If inputs are not provided, the call\n will be accepted but session will not move forward. Inputs for cards that are not in the\n WAITING status will be ignored.

", "smithy.api#http": { "method": "POST", "uri": "/runtime.updateQAppSession" @@ -7104,7 +7191,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration metadata of a session for a given Q App sessionId.

", + "smithy.api#documentation": "

Updates the configuration metadata of a session for a given Q App\n sessionId.

", "smithy.api#examples": [ { "title": "Updates an existing session metadata for an Amazon Q App", diff --git a/codegen/sdk-codegen/aws-models/qbusiness.json b/codegen/sdk-codegen/aws-models/qbusiness.json index 5d29a31ce1a..e8e96c4b431 100644 --- a/codegen/sdk-codegen/aws-models/qbusiness.json +++ b/codegen/sdk-codegen/aws-models/qbusiness.json @@ -96,6 +96,39 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.qbusiness#ActionConfiguration": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.qbusiness#QIamAction", + "traits": { + "smithy.api#documentation": "

The Q Business action that is allowed.

", + "smithy.api#required": {} + } + }, + "filterConfiguration": { + "target": "com.amazonaws.qbusiness#ActionFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The filter configuration for the action, if any.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an allowed action and its associated filter configuration.

" + } + }, + "com.amazonaws.qbusiness#ActionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#ActionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.qbusiness#ActionExecution": { "type": "structure", "members": { @@ -178,6 +211,20 @@ "smithy.api#documentation": "

A user input field in an plugin action execution payload.

" } }, + "com.amazonaws.qbusiness#ActionFilterConfiguration": { + "type": "structure", + "members": { + "documentAttributeFilter": { + "target": "com.amazonaws.qbusiness#AttributeFilter", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies filters to apply to an allowed action.

" + } + }, "com.amazonaws.qbusiness#ActionPayloadFieldKey": { "type": "string", "traits": { @@ -366,7 +413,7 @@ "arrayItemJsonSchema": { "target": "com.amazonaws.qbusiness#ActionReviewPayloadFieldArrayItemJsonSchema", "traits": { - "smithy.api#documentation": "

Use to create a custom form with array fields (fields with nested objects inside an\n array).

" + "smithy.api#documentation": "

Use to create a custom form with array fields (fields with nested objects inside an\n array).

" } }, "required": { @@ -409,6 +456,44 @@ "com.amazonaws.qbusiness#ActionReviewPayloadFieldArrayItemJsonSchema": { "type": "document" }, + "com.amazonaws.qbusiness#ActionSummary": { + "type": "structure", + "members": { + "actionIdentifier": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The identifier of an Amazon Q Business plugin action.

" + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The display name assigned by Amazon Q Business to a plugin action. You can't\n modify this value.

" + } + }, + "instructionExample": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

An Amazon Q Business suggested prompt and end user can use to invoke a plugin\n action. This value can be modified and sent as input to initiate an action. For\n example:

\n " + } + }, + "description": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The description of an Amazon Q Business plugin action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information for an Amazon Q Business plugin action.

" + } + }, + "com.amazonaws.qbusiness#Actions": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#ActionSummary" + } + }, "com.amazonaws.qbusiness#AmazonResourceName": { "type": "string", "traits": { @@ -456,6 +541,12 @@ "traits": { "smithy.api#documentation": "

The authentication type being used by a Amazon Q Business application.

" } + }, + "quickSightConfiguration": { + "target": "com.amazonaws.qbusiness#QuickSightConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.

" + } } }, "traits": { @@ -610,6 +701,96 @@ "smithy.api#documentation": "

The creator mode specific admin controls configured for an Amazon Q Business application.\n Determines whether an end user can generate LLM-only responses when they use the web\n experience.

\n

For more information, see Admin controls and guardrails and Conversation settings.

" } }, + "com.amazonaws.qbusiness#AssociatePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#AssociatePermissionRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#AssociatePermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates a permission policy for a Q Business application, allowing cross-account access for an ISV. \n This operation creates a new policy statement for the specified Q Business application. \n The policy statement defines the IAM actions that the ISV is allowed to perform on the Q Business application's resources.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/policy", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#AssociatePermissionRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statementId": { + "target": "com.amazonaws.qbusiness#StatementId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the policy statement.

", + "smithy.api#required": {} + } + }, + "actions": { + "target": "com.amazonaws.qbusiness#QIamActions", + "traits": { + "smithy.api#documentation": "

The list of Q Business actions that the ISV is allowed to perform.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.qbusiness#PrincipalRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the ISV that is being granted permission.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#AssociatePermissionResponse": { + "type": "structure", + "members": { + "statement": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The JSON representation of the added permission statement.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#Attachment": { "type": "structure", "members": { @@ -1843,6 +2024,16 @@ "target": "com.amazonaws.qbusiness#ClientIdForOIDC" } }, + "com.amazonaws.qbusiness#ClientNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]*$" + } + }, "com.amazonaws.qbusiness#ClientToken": { "type": "string", "traits": { @@ -1931,6 +2122,20 @@ "smithy.api#documentation": "

Rules for retrieving content from data sources connected to a Amazon Q Business\n application for a specific topic control configuration.

" } }, + "com.amazonaws.qbusiness#ContentSource": { + "type": "union", + "members": { + "retriever": { + "target": "com.amazonaws.qbusiness#RetrieverContentSource", + "traits": { + "smithy.api#documentation": "

The retriever to use as the content source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the source of content to search in.

" + } + }, "com.amazonaws.qbusiness#ContentType": { "type": "enum", "members": { @@ -2235,6 +2440,12 @@ "traits": { "smithy.api#documentation": "

Configuration information about chat response personalization. For more information,\n see Personalizing chat responses\n

" } + }, + "quickSightConfiguration": { + "target": "com.amazonaws.qbusiness#QuickSightConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is\n required if your application uses QuickSight as the identity provider. For more information, see Creating an\n Amazon QuickSight integrated application.

" + } } }, "traits": { @@ -2261,13 +2472,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.qbusiness#CreateDataSource": { + "com.amazonaws.qbusiness#CreateDataAccessor": { "type": "operation", "input": { - "target": "com.amazonaws.qbusiness#CreateDataSourceRequest" + "target": "com.amazonaws.qbusiness#CreateDataAccessorRequest" }, "output": { - "target": "com.amazonaws.qbusiness#CreateDataSourceResponse" + "target": "com.amazonaws.qbusiness#CreateDataAccessorResponse" }, "errors": [ { @@ -2298,98 +2509,62 @@ "aws:TagKeys" ], "aws.iam#requiredActions": [ - "qbusiness:GetDataSource", + "qbusiness:GetDataAccessor", "qbusiness:TagResource", - "qbusiness:ListTagsForResource", - "iam:PassRole" + "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "

Creates a data source connector for an Amazon Q Business application.

\n

\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.

", + "smithy.api#documentation": "

Creates a new data accessor for an ISV to access data from a Q Business application. \n The data accessor is an entity that represents the ISV's access to the Q Business application's data. \n It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the \n specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, \n an AWS IAM Identity Center application is also created to manage the ISV's identity and authentication for \n accessing the Q Business application.

", "smithy.api#http": { - "uri": "/applications/{applicationId}/indices/{indexId}/datasources", + "uri": "/applications/{applicationId}/dataaccessors", "method": "POST" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.qbusiness#CreateDataSourceRequest": { + "com.amazonaws.qbusiness#CreateDataAccessorRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application the data source will be attached\n to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "indexId": { - "target": "com.amazonaws.qbusiness#IndexId", - "traits": { - "smithy.api#documentation": "

The identifier of the index that you want to use with the data source\n connector.

", + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "displayName": { - "target": "com.amazonaws.qbusiness#DataSourceName", + "principal": { + "target": "com.amazonaws.qbusiness#PrincipalRoleArn", "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A name for the data source connector.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.

", "smithy.api#required": {} } }, - "configuration": { - "target": "com.amazonaws.qbusiness#DataSourceConfiguration", + "actionConfigurations": { + "target": "com.amazonaws.qbusiness#ActionConfigurationList", "traits": { - "smithy.api#documentation": "

Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration\n information specific to your data source connector.

\n

Each data source has a JSON schema provided by Amazon Q Business that you must\n use. For example, the Amazon S3 and Web Crawler connectors require the following\n JSON schemas:

\n \n

You can find configuration templates for your specific data source using the following\n steps:

\n
    \n
  1. \n

    Navigate to the Supported\n connectors page in the Amazon Q Business User Guide, and\n select the data source of your choice.

    \n
    2. \n
  2. \n

    Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your\n data source, including parameter descriptions, in this section.

    \n
    3. \n
", + "smithy.api#documentation": "

A list of action configurations specifying the allowed actions and any associated filters.

", "smithy.api#required": {} } }, - "vpcConfiguration": { - "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q Business connectors.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier you provide to ensure idempotency of the request.

", + "smithy.api#idempotencyToken": {} } }, - "description": { - "target": "com.amazonaws.qbusiness#Description", + "displayName": { + "target": "com.amazonaws.qbusiness#DataAccessorName", "traits": { - "smithy.api#documentation": "

A description for the data source connector.

" + "smithy.api#documentation": "

A friendly name for the data accessor.

", + "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You\n can also use tags to help control access to the data source connector. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" - } - }, - "syncSchedule": { - "target": "com.amazonaws.qbusiness#SyncSchedule", - "traits": { - "smithy.api#documentation": "

Sets the frequency for Amazon Q Business to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q Business won't\n periodically update the index.

\n

Specify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.

" - } - }, - "roleArn": { - "target": "com.amazonaws.qbusiness#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access\n the data source and required resources.

" - } - }, - "clientToken": { - "target": "com.amazonaws.qbusiness#ClientToken", - "traits": { - "smithy.api#documentation": "

A token you provide to identify a request to create a data source connector. Multiple\n calls to the CreateDataSource API with the same client token will create\n only one data source connector.

", - "smithy.api#idempotencyToken": {} - } - }, - "documentEnrichmentConfiguration": { - "target": "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration" - }, - "mediaExtractionConfiguration": { - "target": "com.amazonaws.qbusiness#MediaExtractionConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for extracting information from media in documents during ingestion.

" + "smithy.api#documentation": "

The tags to associate with the data accessor.

" } } }, @@ -2397,19 +2572,28 @@ "smithy.api#input": {} } }, - "com.amazonaws.qbusiness#CreateDataSourceResponse": { + "com.amazonaws.qbusiness#CreateDataAccessorResponse": { "type": "structure", "members": { - "dataSourceId": { - "target": "com.amazonaws.qbusiness#DataSourceId", + "dataAccessorId": { + "target": "com.amazonaws.qbusiness#DataAccessorId", "traits": { - "smithy.api#documentation": "

The identifier of the data source connector.

" + "smithy.api#documentation": "

The unique identifier of the created data accessor.

", + "smithy.api#required": {} } }, - "dataSourceArn": { - "target": "com.amazonaws.qbusiness#DataSourceArn", + "idcApplicationArn": { + "target": "com.amazonaws.qbusiness#IdcApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS IAM Identity Center application created for this data accessor.

", + "smithy.api#required": {} + } + }, + "dataAccessorArn": { + "target": "com.amazonaws.qbusiness#DataAccessorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created data accessor.

", + "smithy.api#required": {} } } }, @@ -2417,13 +2601,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.qbusiness#CreateIndex": { + "com.amazonaws.qbusiness#CreateDataSource": { "type": "operation", "input": { - "target": "com.amazonaws.qbusiness#CreateIndexRequest" + "target": "com.amazonaws.qbusiness#CreateDataSourceRequest" }, "output": { - "target": "com.amazonaws.qbusiness#CreateIndexResponse" + "target": "com.amazonaws.qbusiness#CreateDataSourceResponse" }, "errors": [ { @@ -2454,18 +2638,174 @@ "aws:TagKeys" ], "aws.iam#requiredActions": [ - "qbusiness:GetIndex", + "qbusiness:GetDataSource", "qbusiness:TagResource", - "qbusiness:ListTagsForResource" + "qbusiness:ListTagsForResource", + "iam:PassRole" ], - "smithy.api#documentation": "

Creates an Amazon Q Business index.

\n

To determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.

\n

Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.

", + "smithy.api#documentation": "

Creates a data source connector for an Amazon Q Business application.

\n

\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.

", "smithy.api#http": { - "uri": "/applications/{applicationId}/indices", + "uri": "/applications/{applicationId}/indices/{indexId}/datasources", "method": "POST" - } + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.qbusiness#CreateIndexRequest": { + "com.amazonaws.qbusiness#CreateDataSourceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q Business application the data source will be attached\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index that you want to use with the data source\n connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#DataSourceName", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A name for the data source connector.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qbusiness#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration\n information specific to your data source connector.

\n

Each data source has a JSON schema provided by Amazon Q Business that you must\n use. For example, the Amazon S3 and Web Crawler connectors require the following\n JSON schemas:

\n \n

You can find configuration templates for your specific data source using the following\n steps:

\n
    \n
  1. \n

    Navigate to the Supported\n connectors page in the Amazon Q Business User Guide, and\n select the data source of your choice.

    \n
    2. \n
  2. \n

    Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your\n data source, including parameter descriptions, in this section.

    \n
    3. \n
", + "smithy.api#required": {} + } + }, + "vpcConfiguration": { + "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q Business connectors.

" + } + }, + "description": { + "target": "com.amazonaws.qbusiness#Description", + "traits": { + "smithy.api#documentation": "

A description for the data source connector.

" + } + }, + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You\n can also use tags to help control access to the data source connector. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + } + }, + "syncSchedule": { + "target": "com.amazonaws.qbusiness#SyncSchedule", + "traits": { + "smithy.api#documentation": "

Sets the frequency for Amazon Q Business to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q Business won't\n periodically update the index.

\n

Specify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.

" + } + }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access\n the data source and required resources.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token you provide to identify a request to create a data source connector. Multiple\n calls to the CreateDataSource API with the same client token will create\n only one data source connector.

", + "smithy.api#idempotencyToken": {} + } + }, + "documentEnrichmentConfiguration": { + "target": "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration" + }, + "mediaExtractionConfiguration": { + "target": "com.amazonaws.qbusiness#MediaExtractionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for extracting information from media in documents during ingestion.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateDataSourceResponse": { + "type": "structure", + "members": { + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

" + } + }, + "dataSourceArn": { + "target": "com.amazonaws.qbusiness#DataSourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#CreateIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateIndexRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "aws.iam#requiredActions": [ + "qbusiness:GetIndex", + "qbusiness:TagResource", + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Creates an Amazon Q Business index.

\n

To determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.

\n

Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#CreateIndexRequest": { "type": "structure", "members": { "applicationId": { @@ -3015,6 +3355,12 @@ "traits": { "smithy.api#documentation": "

The browser extension configuration for an Amazon Q Business web experience.

\n \n

\n For Amazon Q Business application using external OIDC-compliant identity providers (IdPs).\n The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application.\n For more information, see Configure external OIDC identity provider for your browser extensions..\n

\n " } + }, + "customizationConfiguration": { + "target": "com.amazonaws.qbusiness#CustomizationConfiguration", + "traits": { + "smithy.api#documentation": "

Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.

" + } } }, "traits": { @@ -3073,6 +3419,16 @@ } } }, + "com.amazonaws.qbusiness#CustomCSSUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^(https?://[a-zA-Z0-9-_.+%/]+\\.css)?$" + } + }, "com.amazonaws.qbusiness#CustomPluginConfiguration": { "type": "structure", "members": { @@ -3102,6 +3458,98 @@ "smithy.api#documentation": "

Configuration information required to create a custom plugin.

" } }, + "com.amazonaws.qbusiness#CustomizationConfiguration": { + "type": "structure", + "members": { + "customCSSUrl": { + "target": "com.amazonaws.qbusiness#CustomCSSUrl", + "traits": { + "smithy.api#documentation": "

Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.

" + } + }, + "logoUrl": { + "target": "com.amazonaws.qbusiness#LogoUrl", + "traits": { + "smithy.api#documentation": "

Provides the URL where the custom logo file is hosted for an Amazon Q web experience.

" + } + }, + "fontUrl": { + "target": "com.amazonaws.qbusiness#FontUrl", + "traits": { + "smithy.api#documentation": "

Provides the URL where the custom font file is hosted for an Amazon Q web experience.

" + } + }, + "faviconUrl": { + "target": "com.amazonaws.qbusiness#FaviconUrl", + "traits": { + "smithy.api#documentation": "

Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

" + } + }, + "com.amazonaws.qbusiness#DataAccessor": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#DataAccessorName", + "traits": { + "smithy.api#documentation": "

The friendly name of the data accessor.

" + } + }, + "dataAccessorId": { + "target": "com.amazonaws.qbusiness#DataAccessorId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data accessor.

" + } + }, + "dataAccessorArn": { + "target": "com.amazonaws.qbusiness#DataAccessorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data accessor.

" + } + }, + "idcApplicationArn": { + "target": "com.amazonaws.qbusiness#IdcApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated AWS IAM Identity Center application.

" + } + }, + "principal": { + "target": "com.amazonaws.qbusiness#PrincipalRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

" + } + }, + "createdAt": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the data accessor was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the data accessor was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a data accessor.

" + } + }, + "com.amazonaws.qbusiness#DataAccessorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, "com.amazonaws.qbusiness#DataAccessorId": { "type": "string", "traits": { @@ -3112,6 +3560,17 @@ "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" } }, + "com.amazonaws.qbusiness#DataAccessorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qbusiness#DataAccessorResource": { "type": "resource", "identifiers": { @@ -3122,12 +3581,33 @@ "target": "com.amazonaws.qbusiness#DataAccessorId" } }, + "create": { + "target": "com.amazonaws.qbusiness#CreateDataAccessor" + }, + "read": { + "target": "com.amazonaws.qbusiness#GetDataAccessor" + }, + "update": { + "target": "com.amazonaws.qbusiness#UpdateDataAccessor" + }, + "delete": { + "target": "com.amazonaws.qbusiness#DeleteDataAccessor" + }, + "list": { + "target": "com.amazonaws.qbusiness#ListDataAccessors" + }, "traits": { "aws.cloudformation#cfnResource": { "name": "DataAccessor" } } }, + "com.amazonaws.qbusiness#DataAccessors": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DataAccessor" + } + }, "com.amazonaws.qbusiness#DataSource": { "type": "structure", "members": { @@ -3693,13 +4173,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.qbusiness#DeleteDataSource": { + "com.amazonaws.qbusiness#DeleteDataAccessor": { "type": "operation", "input": { - "target": "com.amazonaws.qbusiness#DeleteDataSourceRequest" + "target": "com.amazonaws.qbusiness#DeleteDataAccessorRequest" }, "output": { - "target": "com.amazonaws.qbusiness#DeleteDataSourceResponse" + "target": "com.amazonaws.qbusiness#DeleteDataAccessorResponse" }, "errors": [ { @@ -3723,17 +4203,88 @@ ], "traits": { "aws.iam#requiredActions": [ - "qbusiness:GetDataSource" + "qbusiness:GetDataAccessor" ], - "smithy.api#documentation": "

Deletes an Amazon Q Business data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.

", + "smithy.api#documentation": "

Deletes a specified data accessor. This operation permanently removes the data accessor \n and its associated AWS IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked

", "smithy.api#http": { - "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "uri": "/applications/{applicationId}/dataaccessors/{dataAccessorId}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.qbusiness#DeleteDataSourceRequest": { + "com.amazonaws.qbusiness#DeleteDataAccessorRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataAccessorId": { + "target": "com.amazonaws.qbusiness#DataAccessorId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data accessor to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteDataAccessorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetDataSource" + ], + "smithy.api#documentation": "

Deletes an Amazon Q Business data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteDataSourceRequest": { "type": "structure", "members": { "applicationId": { @@ -4238,6 +4789,74 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.qbusiness#DisassociatePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DisassociatePermissionRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DisassociatePermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a permission policy from a Q Business application, revoking the cross-account access that was \n previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/policy/{statementId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DisassociatePermissionRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statementId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The statement ID of the permission to remove.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DisassociatePermissionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#Document": { "type": "structure", "members": { @@ -4952,6 +5571,9 @@ "type": "service", "version": "2023-11-27", "operations": [ + { + "target": "com.amazonaws.qbusiness#AssociatePermission" + }, { "target": "com.amazonaws.qbusiness#BatchDeleteDocument" }, @@ -4979,6 +5601,9 @@ { "target": "com.amazonaws.qbusiness#DeleteUser" }, + { + "target": "com.amazonaws.qbusiness#DisassociatePermission" + }, { "target": "com.amazonaws.qbusiness#GetChatControlsConfiguration" }, @@ -4988,6 +5613,9 @@ { "target": "com.amazonaws.qbusiness#GetMedia" }, + { + "target": "com.amazonaws.qbusiness#GetPolicy" + }, { "target": "com.amazonaws.qbusiness#GetUser" }, @@ -5009,6 +5637,15 @@ { "target": "com.amazonaws.qbusiness#ListMessages" }, + { + "target": "com.amazonaws.qbusiness#ListPluginActions" + }, + { + "target": "com.amazonaws.qbusiness#ListPluginTypeActions" + }, + { + "target": "com.amazonaws.qbusiness#ListPluginTypeMetadata" + }, { "target": "com.amazonaws.qbusiness#ListTagsForResource" }, @@ -5018,6 +5655,9 @@ { "target": "com.amazonaws.qbusiness#PutGroup" }, + { + "target": "com.amazonaws.qbusiness#SearchRelevantContent" + }, { "target": "com.amazonaws.qbusiness#StartDataSourceSyncJob" }, @@ -5508,6 +6148,26 @@ "target": "com.amazonaws.qbusiness#FailedDocument" } }, + "com.amazonaws.qbusiness#FaviconUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^(https?://[a-zA-Z0-9-_.+%/]+\\.(svg|ico))?$" + } + }, + "com.amazonaws.qbusiness#FontUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^(https?://[a-zA-Z0-9-_.+%/]+\\.(ttf|woff|woff2|otf))?$" + } + }, "com.amazonaws.qbusiness#GetApplication": { "type": "operation", "input": { @@ -5674,6 +6334,12 @@ "traits": { "smithy.api#documentation": "

The OIDC client ID for a Amazon Q Business application.

" } + }, + "quickSightConfiguration": { + "target": "com.amazonaws.qbusiness#QuickSightConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight authentication configuration for the Amazon Q Business application.

" + } } }, "traits": { @@ -5789,6 +6455,129 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#GetDataAccessor": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetDataAccessorRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetDataAccessorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Retrieves information about a specified data accessor. This operation returns details about the \n data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated \n Q Business application and AWS IAM Identity Center application, the IAM role for the ISV, the \n action configurations, and the timestamps for when the data accessor was created and last updated.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/dataaccessors/{dataAccessorId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetDataAccessorRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataAccessorId": { + "target": "com.amazonaws.qbusiness#DataAccessorId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data accessor to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetDataAccessorResponse": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#DataAccessorName", + "traits": { + "smithy.api#documentation": "

The friendly name of the data accessor.

" + } + }, + "dataAccessorId": { + "target": "com.amazonaws.qbusiness#DataAccessorId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data accessor.

" + } + }, + "dataAccessorArn": { + "target": "com.amazonaws.qbusiness#DataAccessorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data accessor.

" + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application associated with this data accessor.

" + } + }, + "idcApplicationArn": { + "target": "com.amazonaws.qbusiness#IdcApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS IAM Identity Center application associated with this data accessor.

" + } + }, + "principal": { + "target": "com.amazonaws.qbusiness#PrincipalRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

" + } + }, + "actionConfigurations": { + "target": "com.amazonaws.qbusiness#ActionConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of action configurations specifying the allowed actions and any associated filters.

" + } + }, + "createdAt": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the data accessor was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the data accessor was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#GetDataSource": { "type": "operation", "input": { @@ -6448,13 +7237,77 @@ "smithy.api#output": {} } }, - "com.amazonaws.qbusiness#GetRetriever": { + "com.amazonaws.qbusiness#GetPolicy": { "type": "operation", "input": { - "target": "com.amazonaws.qbusiness#GetRetrieverRequest" + "target": "com.amazonaws.qbusiness#GetPolicyRequest" }, "output": { - "target": "com.amazonaws.qbusiness#GetRetrieverResponse" + "target": "com.amazonaws.qbusiness#GetPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the current permission policy for a Q Business application. The policy is \n returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/policy", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetPolicyRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The JSON representation of the permission policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetRetriever": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetRetrieverRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetRetrieverResponse" }, "errors": [ { @@ -6818,6 +7671,12 @@ "traits": { "smithy.api#documentation": "

The browser extension configuration for an Amazon Q Business web experience.

" } + }, + "customizationConfiguration": { + "target": "com.amazonaws.qbusiness#CustomizationConfiguration", + "traits": { + "smithy.api#documentation": "

Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.\n

" + } } }, "traits": { @@ -6996,6 +7855,28 @@ "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" } }, + "com.amazonaws.qbusiness#IdcAuthConfiguration": { + "type": "structure", + "members": { + "idcApplicationArn": { + "target": "com.amazonaws.qbusiness#IdcApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services\n on your behalf.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the IAM Identity Center Application used to configure authentication for a plugin.

" + } + }, "com.amazonaws.qbusiness#IdentityProviderConfiguration": { "type": "union", "members": { @@ -7030,6 +7911,12 @@ "traits": { "smithy.api#enumValue": "AWS_IAM_IDC" } + }, + "AWS_QUICKSIGHT_IDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_QUICKSIGHT_IDP" + } } } }, @@ -7713,6 +8600,96 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#ListDataAccessors": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListDataAccessorsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListDataAccessorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the data accessors for a Q Business application. This operation returns a paginated \n list of data accessor summaries, including the friendly name, unique identifier, ARN, \n associated IAM role, and creation/update timestamps for each data accessor.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/dataaccessors", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataAccessors" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListDataAccessorsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken1500", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. (You received this token from a previous call.)

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListDataAccessors", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListDataAccessorsResponse": { + "type": "structure", + "members": { + "dataAccessors": { + "target": "com.amazonaws.qbusiness#DataAccessors", + "traits": { + "smithy.api#documentation": "

The list of data accessors.

" + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken1500", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next set of results, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#ListDataSourceSyncJobs": { "type": "operation", "input": { @@ -8324,14 +9301,278 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the number of messages returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of messages.

", + "smithy.api#documentation": "

If the number of messages returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of messages.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListMessages", + "traits": { + "smithy.api#documentation": "

The maximum number of messages to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListMessagesResponse": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.qbusiness#Messages", + "traits": { + "smithy.api#documentation": "

An array of information on one or more messages.

" + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListPluginActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListPluginActionsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListPluginActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/plugins/{pluginId}/actions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListPluginActionsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q Business application the plugin is attached\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q Business plugin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set\n of plugin actions.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListPluginActions", + "traits": { + "smithy.api#documentation": "

The maximum number of plugin actions to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListPluginActionsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you\n can use in a later request to list the next set of plugin actions.

" + } + }, + "items": { + "target": "com.amazonaws.qbusiness#Actions", + "traits": { + "smithy.api#documentation": "

An array of information on one or more plugin actions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListPluginTypeActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListPluginTypeActionsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListPluginTypeActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists configured Amazon Q Business actions for any plugin type—both\n built-in and custom.

", + "smithy.api#http": { + "method": "GET", + "uri": "/pluginTypes/{pluginType}/actions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListPluginTypeActionsRequest": { + "type": "structure", + "members": { + "pluginType": { + "target": "com.amazonaws.qbusiness#PluginType", + "traits": { + "smithy.api#documentation": "

The type of the plugin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the number of plugins returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set\n of plugins.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListPluginTypeActions", + "traits": { + "smithy.api#documentation": "

The maximum number of plugins to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListPluginTypeActionsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you\n can use in a later request to list the next set of plugins.

" + } + }, + "items": { + "target": "com.amazonaws.qbusiness#Actions", + "traits": { + "smithy.api#documentation": "

An array of information on one or more plugins.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListPluginTypeMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListPluginTypeMetadataRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListPluginTypeMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists metadata for all Amazon Q Business plugin types.

", + "smithy.api#http": { + "method": "GET", + "uri": "/pluginTypeMetadata" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListPluginTypeMetadataRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the metadata returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of metadata.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { - "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListMessages", + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListPluginTypeMetadata", "traits": { - "smithy.api#documentation": "

The maximum number of messages to return.

", + "smithy.api#documentation": "

The maximum number of plugin metadata items to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -8340,19 +9581,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.qbusiness#ListMessagesResponse": { + "com.amazonaws.qbusiness#ListPluginTypeMetadataResponse": { "type": "structure", "members": { - "messages": { - "target": "com.amazonaws.qbusiness#Messages", + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

An array of information on one or more messages.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you\n can use in a later request to list the next set of plugin metadata.

" } }, - "nextToken": { - "target": "com.amazonaws.qbusiness#NextToken", + "items": { + "target": "com.amazonaws.qbusiness#ListPluginTypeMetadataSummaries", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.

" + "smithy.api#documentation": "

An array of information on plugin metadata.

" } } }, @@ -8360,6 +9601,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#ListPluginTypeMetadataSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#PluginTypeMetadataSummary" + } + }, "com.amazonaws.qbusiness#ListPlugins": { "type": "operation", "input": { @@ -8694,9 +9941,22 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#LogoUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^(https?://[a-zA-Z0-9-_.+%/]+\\.(svg|png))?$" + } + }, "com.amazonaws.qbusiness#Long": { "type": "long" }, + "com.amazonaws.qbusiness#MaxResults": { + "type": "integer" + }, "com.amazonaws.qbusiness#MaxResultsIntegerForGetTopicConfigurations": { "type": "integer", "traits": { @@ -8733,6 +9993,15 @@ } } }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListDataAccessors": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.qbusiness#MaxResultsIntegerForListDataSources": { "type": "integer", "traits": { @@ -8787,6 +10056,33 @@ } } }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListPluginActions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListPluginTypeActions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListPluginTypeMetadata": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.qbusiness#MaxResultsIntegerForListPlugins": { "type": "integer", "traits": { @@ -9247,6 +10543,15 @@ } } }, + "com.amazonaws.qbusiness#NextToken1500": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1500 + } + } + }, "com.amazonaws.qbusiness#NoAuthConfiguration": { "type": "structure", "members": {}, @@ -9308,6 +10613,18 @@ "smithy.api#documentation": "

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0\n authentication credentials stored in a Secrets Manager secret.

", "smithy.api#required": {} } + }, + "authorizationUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to\n authenticate a plugin user through a third party authentication server.

" + } + }, + "tokenUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code\n for an access token.

" + } } }, "traits": { @@ -9470,6 +10787,12 @@ "traits": { "smithy.api#documentation": "

Information about invoking a custom plugin without any authentication.

" } + }, + "idcAuthConfiguration": { + "target": "com.amazonaws.qbusiness#IdcAuthConfiguration", + "traits": { + "smithy.api#documentation": "

Information about the IAM Identity Center Application used to configure authentication for a plugin.

" + } } }, "traits": { @@ -9647,7 +10970,140 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + }, + "SERVICENOW_NOW_PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICENOW_NOW_PLATFORM" + } + }, + "JIRA_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRA_CLOUD" + } + }, + "SALESFORCE_CRM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE_CRM" + } + }, + "ZENDESK_SUITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZENDESK_SUITE" + } + }, + "ATLASSIAN_CONFLUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATLASSIAN_CONFLUENCE" + } + }, + "GOOGLE_CALENDAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLE_CALENDAR" + } + }, + "MICROSOFT_TEAMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_TEAMS" + } + }, + "MICROSOFT_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_EXCHANGE" + } + }, + "PAGERDUTY_ADVANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGERDUTY_ADVANCE" + } + }, + "SMARTSHEET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMARTSHEET" + } + }, + "ASANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASANA" + } + } + } + }, + "com.amazonaws.qbusiness#PluginTypeCategory": { + "type": "enum", + "members": { + "CRM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Customer relationship management (CRM)" + } + }, + "PROJECT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Project management" + } + }, + "COMMUNICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Communication" + } + }, + "PRODUCTIVITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Productivity" + } + }, + "TICKETING_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ticketing and incident management" + } + } + } + }, + "com.amazonaws.qbusiness#PluginTypeMetadataSummary": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.qbusiness#PluginType", + "traits": { + "smithy.api#documentation": "

The type of the plugin.

" + } + }, + "category": { + "target": "com.amazonaws.qbusiness#PluginTypeCategory", + "traits": { + "smithy.api#documentation": "

The category of the plugin type.

" + } + }, + "description": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The description assigned by Amazon Q Business to a plugin. You can't\n modify this value.

" + } } + }, + "traits": { + "smithy.api#documentation": "

Summary metadata information for a Amazon Q Business plugin.

" } }, "com.amazonaws.qbusiness#Plugins": { @@ -9703,6 +11159,16 @@ "smithy.api#documentation": "

Provides information about a group associated with the principal.

" } }, + "com.amazonaws.qbusiness#PrincipalRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1284 + }, + "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$" + } + }, "com.amazonaws.qbusiness#PrincipalUser": { "type": "structure", "members": { @@ -9947,29 +11413,115 @@ "smithy.api#enumValue": "ENABLED" } }, - "DISABLED": { - "target": "smithy.api#Unit", + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.qbusiness#QIamAction": { + "type": "string", + "traits": { + "smithy.api#pattern": "^qbusiness:[a-zA-Z]+$" + } + }, + "com.amazonaws.qbusiness#QIamActions": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#QIamAction" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#QueryText": { + "type": "string" + }, + "com.amazonaws.qbusiness#QuickSightConfiguration": { + "type": "structure", + "members": { + "clientNamespace": { + "target": "com.amazonaws.qbusiness#ClientNamespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see \n Namespace operations.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.\n For more information, see Creating an\n Amazon QuickSight integrated application.

" + } + }, + "com.amazonaws.qbusiness#ReadAccessType": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.qbusiness#RelevantContent": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The actual content of the relevant item.

" + } + }, + "documentId": { + "target": "com.amazonaws.qbusiness#DocumentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the document containing the relevant content.

" + } + }, + "documentTitle": { + "target": "com.amazonaws.qbusiness#Title", + "traits": { + "smithy.api#documentation": "

The title of the document containing the relevant content.

" + } + }, + "documentUri": { + "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "

The URI of the document containing the relevant content.

" } - } - } - }, - "com.amazonaws.qbusiness#ReadAccessType": { - "type": "enum", - "members": { - "ALLOW": { - "target": "smithy.api#Unit", + }, + "documentAttributes": { + "target": "com.amazonaws.qbusiness#DocumentAttributes", "traits": { - "smithy.api#enumValue": "ALLOW" + "smithy.api#documentation": "

Additional attributes of the document containing the relevant content.

" } }, - "DENY": { - "target": "smithy.api#Unit", + "scoreAttributes": { + "target": "com.amazonaws.qbusiness#ScoreAttributes", "traits": { - "smithy.api#enumValue": "DENY" + "smithy.api#documentation": "

Attributes related to the relevance score of the content.

" } } + }, + "traits": { + "smithy.api#documentation": "

Represents a piece of content that is relevant to a search query.

" + } + }, + "com.amazonaws.qbusiness#RelevantContentList": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#RelevantContent" } }, "com.amazonaws.qbusiness#ResourceNotFoundException": { @@ -9998,7 +11550,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource you want to use doesn’t exist. Make sure you have provided the correct\n resource and try again.

", + "smithy.api#documentation": "

The application or plugin resource you want to use doesn’t exist. Make sure you have\n provided the correct resource and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -10088,6 +11640,21 @@ "smithy.api#documentation": "

Provides information on how the retriever used for your Amazon Q Business application is\n configured.

" } }, + "com.amazonaws.qbusiness#RetrieverContentSource": { + "type": "structure", + "members": { + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the retriever to use as the content source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a retriever as the content source for a search.

" + } + }, "com.amazonaws.qbusiness#RetrieverId": { "type": "string", "traits": { @@ -10393,6 +11960,176 @@ "smithy.api#documentation": "

Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate\n end users of an Amazon Q Business web experience.

" } }, + "com.amazonaws.qbusiness#ScoreAttributes": { + "type": "structure", + "members": { + "scoreConfidence": { + "target": "com.amazonaws.qbusiness#ScoreConfidence", + "traits": { + "smithy.api#documentation": "

The confidence level of the relevance score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the relevance score of content.

" + } + }, + "com.amazonaws.qbusiness#ScoreConfidence": { + "type": "enum", + "members": { + "VERY_HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERY_HIGH" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + } + } + }, + "com.amazonaws.qbusiness#SearchRelevantContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#SearchRelevantContentRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#SearchRelevantContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#LicenseNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for relevant content in a Q Business application based on a query. This operation takes a \n search query text, the Q Business application identifier, and optional filters \n (such as user ID, user groups, content source, and maximum results) as input. It returns a list of \n relevant content items, where each item includes the content text, the unique document identifier, \n the document title, the document URI, any relevant document attributes, and score attributes \n indicating the confidence level of the relevance.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/relevant-content", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "relevantContent" + } + } + }, + "com.amazonaws.qbusiness#SearchRelevantContentRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application to search.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The ID of the user performing the search. Used for access control.

", + "smithy.api#httpQuery": "userId" + } + }, + "userGroups": { + "target": "com.amazonaws.qbusiness#UserGroups", + "traits": { + "smithy.api#documentation": "

The groups the user belongs to. Used for access control.

", + "smithy.api#httpQuery": "userGroups" + } + }, + "queryText": { + "target": "com.amazonaws.qbusiness#QueryText", + "traits": { + "smithy.api#documentation": "

The text to search for.

", + "smithy.api#required": {} + } + }, + "contentSource": { + "target": "com.amazonaws.qbusiness#ContentSource", + "traits": { + "smithy.api#documentation": "

The source of content to search in.

", + "smithy.api#required": {} + } + }, + "attributeFilter": { + "target": "com.amazonaws.qbusiness#AttributeFilter" + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. (You received this token from a previous call.)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#SearchRelevantContentResponse": { + "type": "structure", + "members": { + "relevantContent": { + "target": "com.amazonaws.qbusiness#RelevantContentList", + "traits": { + "smithy.api#documentation": "

The list of relevant content items found.

" + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next set of results, if there are any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#SecretArn": { "type": "string", "traits": { @@ -10621,6 +12358,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#StatementId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, "com.amazonaws.qbusiness#Status": { "type": "enum", "members": { @@ -11492,6 +13239,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#UpdateDataAccessor": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateDataAccessorRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateDataAccessorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetDataAccessor", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Updates an existing data accessor. This operation allows modifying the action configurations \n (the allowed actions and associated filters) and the display name of the data accessor. \n It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/dataaccessors/{dataAccessorId}", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateDataAccessorRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataAccessorId": { + "target": "com.amazonaws.qbusiness#DataAccessorId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data accessor to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionConfigurations": { + "target": "com.amazonaws.qbusiness#ActionConfigurationList", + "traits": { + "smithy.api#documentation": "

The updated list of action configurations specifying the allowed actions and any associated filters.

", + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#DataAccessorName", + "traits": { + "smithy.api#documentation": "

The updated friendly name for the data accessor.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateDataAccessorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#UpdateDataSource": { "type": "operation", "input": { @@ -12136,6 +13970,12 @@ "traits": { "smithy.api#documentation": "

The browser extension configuration for an Amazon Q Business web experience.

\n \n

\n For Amazon Q Business application using external OIDC-compliant identity providers (IdPs).\n The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application.\n For more information, see Configure external OIDC identity provider for your browser extensions..\n

\n " } + }, + "customizationConfiguration": { + "target": "com.amazonaws.qbusiness#CustomizationConfiguration", + "traits": { + "smithy.api#documentation": "

Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 68bf9976abc..c949cbe8c3c 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -12731,6 +12731,62 @@ "smithy.api#documentation": "

The visual publish options of a visual in a dashboard

" } }, + "com.amazonaws.quicksight#DashboardVisualResult": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard.

" + } + }, + "DashboardName": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

The name of the dashboard.

" + } + }, + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the sheet.

" + } + }, + "SheetName": { + "target": "com.amazonaws.quicksight#SheetName", + "traits": { + "smithy.api#documentation": "

The name of the sheet.

" + } + }, + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual.

" + } + }, + "VisualTitle": { + "target": "com.amazonaws.quicksight#VisualTitle", + "traits": { + "smithy.api#documentation": "

The title of the visual.

" + } + }, + "VisualSubtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitle", + "traits": { + "smithy.api#documentation": "

The subtitle of the visual.

" + } + }, + "DashboardUrl": { + "target": "com.amazonaws.quicksight#QAUrl", + "traits": { + "smithy.api#documentation": "

The URL of the dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The QA result that is made from dashboard visual.

" + } + }, "com.amazonaws.quicksight#DashboardsQAStatus": { "type": "enum", "members": { @@ -16722,6 +16778,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DeleteDefaultQBusinessApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDefaultQBusinessApplicationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDefaultQBusinessApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a linked Amazon Q Business application from an Amazon QuickSight account

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/default-qbusiness-application", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDefaultQBusinessApplicationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight account that you want to disconnect from a Amazon Q Business application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.

", + "smithy.api#httpQuery": "namespace" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDefaultQBusinessApplicationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteFolder": { "type": "operation", "input": { @@ -21156,6 +21291,91 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeDefaultQBusinessApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDefaultQBusinessApplicationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDefaultQBusinessApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/default-qbusiness-application", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDefaultQBusinessApplicationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight account that is linked to the Amazon Q Business application that you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

", + "smithy.api#httpQuery": "namespace" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDefaultQBusinessApplicationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "ApplicationId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Q Business application that is linked to the Amazon QuickSight account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeFolder": { "type": "operation", "input": { @@ -22278,6 +22498,87 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeQuickSightQSearchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeQuickSightQSearchConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeQuickSightQSearchConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the state of a Amazon QuickSight Q Search configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/quicksight-q-search-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeQuickSightQSearchConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that the user wants described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeQuickSightQSearchConfigurationResponse": { + "type": "structure", + "members": { + "QSearchStatus": { + "target": "com.amazonaws.quicksight#QSearchStatus", + "traits": { + "smithy.api#documentation": "

The status of Amazon QuickSight Q Search configuration.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeRefreshSchedule": { "type": "operation", "input": { @@ -27468,21 +27769,140 @@ } ], "traits": { - "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. \n Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. \n Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/embed-url/registered-user", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" + } + }, + "UserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name for the registered user.

", + "smithy.api#required": {} + } + }, + "ExperienceConfiguration": { + "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", + "traits": { + "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "AllowedDomains": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {}, + "smithy.api#required": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserWithIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserWithIdentityRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserWithIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

\n

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

", "smithy.api#http": { "method": "POST", - "uri": "/accounts/{AwsAccountId}/embed-url/registered-user", + "uri": "/accounts/{AwsAccountId}/embed-url/registered-user-with-identity", "code": 200 } } }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest": { + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserWithIdentityRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services registered user.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -27490,27 +27910,19 @@ "SessionLifetimeInMinutes": { "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" - } - }, - "UserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name for the registered user.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The validity of the session in minutes.

" } }, "ExperienceConfiguration": { "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", "traits": { - "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

", "smithy.api#required": {} } }, "AllowedDomains": { "target": "com.amazonaws.quicksight#StringList", "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + "smithy.api#documentation": "

A list of domains to be allowed to generate the embed URL.

" } } }, @@ -27518,13 +27930,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse": { + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserWithIdentityResponse": { "type": "structure", "members": { "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", + "smithy.api#documentation": "

The generated embed URL for the registered user.

", "smithy.api#required": {} } }, @@ -27549,6 +27961,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#GeneratedAnswerResult": { + "type": "structure", + "members": { + "QuestionText": { + "target": "com.amazonaws.quicksight#QAQueryText", + "traits": { + "smithy.api#documentation": "

The question text.

" + } + }, + "AnswerStatus": { + "target": "com.amazonaws.quicksight#GeneratedAnswerStatus", + "traits": { + "smithy.api#documentation": "

The answer status of the generated answer.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic.

" + } + }, + "TopicName": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the topic.

" + } + }, + "Restatement": { + "target": "com.amazonaws.quicksight#QAQueryText", + "traits": { + "smithy.api#documentation": "

The restatement for the answer.

" + } + }, + "QuestionId": { + "target": "com.amazonaws.quicksight#QuestionId", + "traits": { + "smithy.api#documentation": "

The ID of the question.

" + } + }, + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The ID of the answer.

" + } + }, + "QuestionUrl": { + "target": "com.amazonaws.quicksight#QAUrl", + "traits": { + "smithy.api#documentation": "

The URL of the question.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The QA result that is made from generated answer.

" + } + }, + "com.amazonaws.quicksight#GeneratedAnswerStatus": { + "type": "enum", + "members": { + "ANSWER_GENERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANSWER_GENERATED" + } + }, + "ANSWER_RETRIEVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANSWER_RETRIEVED" + } + }, + "ANSWER_DOWNGRADE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANSWER_DOWNGRADE" + } + } + } + }, "com.amazonaws.quicksight#GeoSpatialColumnGroup": { "type": "structure", "members": { @@ -30573,6 +31064,40 @@ } } }, + "com.amazonaws.quicksight#IncludeGeneratedAnswer": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "EXCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDE" + } + } + } + }, + "com.amazonaws.quicksight#IncludeQuickSightQIndex": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "EXCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDE" + } + } + } + }, "com.amazonaws.quicksight#IncrementalRefresh": { "type": "structure", "members": { @@ -37318,6 +37843,15 @@ } } }, + "com.amazonaws.quicksight#MaxTopicsToConsider": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 4 + } + } + }, "com.amazonaws.quicksight#MaximumLabelType": { "type": "structure", "members": { @@ -41462,6 +41996,112 @@ } } }, + "com.amazonaws.quicksight#PredictQAResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#PredictQAResultsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#PredictQAResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Predicts existing visuals or generates new visuals to answer a given query.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/qa/predict", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#PredictQAResultsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueryText": { + "target": "com.amazonaws.quicksight#QAQueryText", + "traits": { + "smithy.api#documentation": "

The query text to be used to predict QA results.

", + "smithy.api#required": {} + } + }, + "IncludeQuickSightQIndex": { + "target": "com.amazonaws.quicksight#IncludeQuickSightQIndex", + "traits": { + "smithy.api#documentation": "

Indicates whether Q indicies are included or excluded.

" + } + }, + "IncludeGeneratedAnswer": { + "target": "com.amazonaws.quicksight#IncludeGeneratedAnswer", + "traits": { + "smithy.api#documentation": "

Indicates whether generated answers are included or excluded.

" + } + }, + "MaxTopicsToConsider": { + "target": "com.amazonaws.quicksight#MaxTopicsToConsider", + "traits": { + "smithy.api#documentation": "

The number of maximum topics to be considered to predict QA results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#PredictQAResultsResponse": { + "type": "structure", + "members": { + "PrimaryResult": { + "target": "com.amazonaws.quicksight#QAResult", + "traits": { + "smithy.api#documentation": "

The primary visual response.

" + } + }, + "AdditionalResults": { + "target": "com.amazonaws.quicksight#QAResults", + "traits": { + "smithy.api#documentation": "

Additional visual responses.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#PredictionInterval": { "type": "integer", "traits": { @@ -41757,6 +42397,91 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#QAQueryText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#QAResult": { + "type": "structure", + "members": { + "ResultType": { + "target": "com.amazonaws.quicksight#QAResultType", + "traits": { + "smithy.api#documentation": "

The type of QA result.

" + } + }, + "DashboardVisual": { + "target": "com.amazonaws.quicksight#DashboardVisualResult", + "traits": { + "smithy.api#documentation": "

The representation of a dashboard visual result.

" + } + }, + "GeneratedAnswer": { + "target": "com.amazonaws.quicksight#GeneratedAnswerResult", + "traits": { + "smithy.api#documentation": "

The representation of a generated answer result.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The QA result that is made from the DashboardVisual or GeneratedAnswer.

" + } + }, + "com.amazonaws.quicksight#QAResultType": { + "type": "enum", + "members": { + "DASHBOARD_VISUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHBOARD_VISUAL" + } + }, + "GENERATED_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATED_ANSWER" + } + }, + "NO_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ANSWER" + } + } + } + }, + "com.amazonaws.quicksight#QAResults": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#QAResult" + } + }, + "com.amazonaws.quicksight#QAUrl": { + "type": "string" + }, + "com.amazonaws.quicksight#QSearchStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.quicksight#Query": { "type": "string", "traits": { @@ -41797,6 +42522,16 @@ "smithy.api#documentation": "

A structure that describes the query execution options.

" } }, + "com.amazonaws.quicksight#QuestionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, "com.amazonaws.quicksight#QueueInfo": { "type": "structure", "members": { @@ -41953,6 +42688,9 @@ { "target": "com.amazonaws.quicksight#DeleteDataSource" }, + { + "target": "com.amazonaws.quicksight#DeleteDefaultQBusinessApplication" + }, { "target": "com.amazonaws.quicksight#DeleteFolder" }, @@ -42082,6 +42820,9 @@ { "target": "com.amazonaws.quicksight#DescribeDataSourcePermissions" }, + { + "target": "com.amazonaws.quicksight#DescribeDefaultQBusinessApplication" + }, { "target": "com.amazonaws.quicksight#DescribeFolder" }, @@ -42115,6 +42856,9 @@ { "target": "com.amazonaws.quicksight#DescribeQPersonalizationConfiguration" }, + { + "target": "com.amazonaws.quicksight#DescribeQuickSightQSearchConfiguration" + }, { "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" }, @@ -42166,6 +42910,9 @@ { "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser" }, + { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserWithIdentity" + }, { "target": "com.amazonaws.quicksight#GetDashboardEmbedUrl" }, @@ -42274,6 +43021,9 @@ { "target": "com.amazonaws.quicksight#ListVPCConnections" }, + { + "target": "com.amazonaws.quicksight#PredictQAResults" + }, { "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" }, @@ -42334,6 +43084,9 @@ { "target": "com.amazonaws.quicksight#UpdateAnalysisPermissions" }, + { + "target": "com.amazonaws.quicksight#UpdateApplicationWithTokenExchangeGrant" + }, { "target": "com.amazonaws.quicksight#UpdateBrand" }, @@ -42373,6 +43126,9 @@ { "target": "com.amazonaws.quicksight#UpdateDataSourcePermissions" }, + { + "target": "com.amazonaws.quicksight#UpdateDefaultQBusinessApplication" + }, { "target": "com.amazonaws.quicksight#UpdateFolder" }, @@ -42400,6 +43156,9 @@ { "target": "com.amazonaws.quicksight#UpdateQPersonalizationConfiguration" }, + { + "target": "com.amazonaws.quicksight#UpdateQuickSightQSearchConfiguration" + }, { "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" }, @@ -47387,6 +48146,12 @@ "traits": { "smithy.api#enumValue": "REDSHIFT" } + }, + "QBUSINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QBUSINESS" + } } } }, @@ -56150,6 +56915,92 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateApplicationWithTokenExchangeGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateApplicationWithTokenExchangeGrantRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateApplicationWithTokenExchangeGrantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon QuickSight application with a token exchange grant. This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/application-with-token-exchange-grant", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateApplicationWithTokenExchangeGrantRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account to be updated with a token exchange grant.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon QuickSight application.

", + "smithy.api#httpQuery": "namespace", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateApplicationWithTokenExchangeGrantResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateBrand": { "type": "operation", "input": { @@ -57630,6 +58481,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateDefaultQBusinessApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDefaultQBusinessApplicationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDefaultQBusinessApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Amazon Q Business application that is linked to a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/default-qbusiness-application", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDefaultQBusinessApplicationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon QuickSight account that is connected to the Amazon Q Business application that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

", + "smithy.api#httpQuery": "namespace" + } + }, + "ApplicationId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Q Business application that you want to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDefaultQBusinessApplicationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateFolder": { "type": "operation", "input": { @@ -58557,6 +59497,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateQuickSightQSearchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateQuickSightQSearchConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateQuickSightQSearchConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the state of a Amazon QuickSight Q Search configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/quicksight-q-search-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateQuickSightQSearchConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QSearchStatus": { + "target": "com.amazonaws.quicksight#QSearchStatus", + "traits": { + "smithy.api#documentation": "

The status of the Amazon QuickSight Q Search configuration that the user wants to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateQuickSightQSearchConfigurationResponse": { + "type": "structure", + "members": { + "QSearchStatus": { + "target": "com.amazonaws.quicksight#QSearchStatus", + "traits": { + "smithy.api#documentation": "

The status of the Amazon QuickSight Q Search configuration.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateRefreshSchedule": { "type": "operation", "input": { @@ -61329,6 +62357,15 @@ } } }, + "com.amazonaws.quicksight#VisualSubtitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.quicksight#VisualSubtitleLabelOptions": { "type": "structure", "members": { @@ -61349,6 +62386,15 @@ "smithy.api#documentation": "

The subtitle label options for a visual.

" } }, + "com.amazonaws.quicksight#VisualTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.quicksight#VisualTitleLabelOptions": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/redshift-serverless.json b/codegen/sdk-codegen/aws-models/redshift-serverless.json index df11b9fbb99..2b6b6a2c02d 100644 --- a/codegen/sdk-codegen/aws-models/redshift-serverless.json +++ b/codegen/sdk-codegen/aws-models/redshift-serverless.json @@ -543,7 +543,7 @@ "schedule": { "target": "com.amazonaws.redshiftserverless#Schedule", "traits": { - "smithy.api#documentation": "

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

\n ", + "smithy.api#documentation": "

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

\n ", "smithy.api#required": {} } }, @@ -918,7 +918,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an workgroup in Amazon Redshift Serverless.

", + "smithy.api#documentation": "

Creates an workgroup in Amazon Redshift Serverless.

\n

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that\n you own in a Region from reaching or being reached from the internet through internet\n gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA\n turned on, the following capabilities are blocked:

\n \n

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

", "smithy.api#idempotent": {} } }, @@ -1713,7 +1713,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a database user name and temporary password with\n temporary authorization to log in to Amazon Redshift Serverless.

\n

By default, the temporary credentials expire in 900 seconds. \n You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).

\n \n

The Identity and Access Management (IAM) user or role that runs \n GetCredentials must have an IAM policy attached that allows access to all \n necessary actions and resources.

\n \n

If the DbName parameter is specified, the IAM policy must \n allow access to the resource dbname for the specified database name.

" + "smithy.api#documentation": "

Returns a database user name and temporary password with\n temporary authorization to log in to Amazon Redshift Serverless.

\n

By default, the temporary credentials expire in 900 seconds. \n You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).

\n

The Identity and Access Management (IAM) user or role that runs \n GetCredentials must have an IAM policy attached that allows access to all \n necessary actions and resources.

\n

If the DbName parameter is specified, the IAM policy must \n allow access to the resource dbname for the specified database name.

" } }, "com.amazonaws.redshiftserverless#GetCredentialsRequest": { @@ -2641,6 +2641,84 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#ListManagedWorkgroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListManagedWorkgroupsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListManagedWorkgroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a list of specified managed workgroups in your account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "managedWorkgroups" + } + } + }, + "com.amazonaws.redshiftserverless#ListManagedWorkgroupsRequest": { + "type": "structure", + "members": { + "sourceArn": { + "target": "com.amazonaws.redshiftserverless#SourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the managed \n workgroup in the AWS Glue Data Catalog.

" + } + }, + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "

If your initial ListManagedWorkgroups operation returns a nextToken, \n you can include the returned nextToken in following ListManagedWorkgroups \n operations, which returns results in the next page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

An optional parameter that specifies the maximum number \n of results to return. You can use nextToken to display the next page of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListManagedWorkgroupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. \n The value of nextToken is a unique pagination token for each page.\n To retrieve the next page, make the call again using the returned token.

" + } + }, + "managedWorkgroups": { + "target": "com.amazonaws.redshiftserverless#ManagedWorkgroups", + "traits": { + "smithy.api#documentation": "

The returned array of managed workgroups.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#ListNamespaces": { "type": "operation", "input": { @@ -3449,6 +3527,104 @@ } } }, + "com.amazonaws.redshiftserverless#ManagedWorkgroupListItem": { + "type": "structure", + "members": { + "managedWorkgroupName": { + "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the managed workgroup.

" + } + }, + "managedWorkgroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the managed workgroup.

" + } + }, + "sourceArn": { + "target": "com.amazonaws.redshiftserverless#SourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the managed \n workgroup in the AWS Glue Data Catalog.

" + } + }, + "status": { + "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupStatus", + "traits": { + "smithy.api#documentation": "

The status of the managed workgroup.

" + } + }, + "creationDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation date of the managed workgroup.

", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of Amazon Redshift compute resources managed by AWS Glue.

" + } + }, + "com.amazonaws.redshiftserverless#ManagedWorkgroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:\\-]+$" + } + }, + "com.amazonaws.redshiftserverless#ManagedWorkgroupResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.redshiftserverless#ListManagedWorkgroups" + } + ] + }, + "com.amazonaws.redshiftserverless#ManagedWorkgroupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFYING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + } + } + }, + "com.amazonaws.redshiftserverless#ManagedWorkgroups": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupListItem" + } + }, "com.amazonaws.redshiftserverless#Namespace": { "type": "structure", "members": { @@ -3904,6 +4080,9 @@ { "target": "com.amazonaws.redshiftserverless#CrossVpcEndpointResource" }, + { + "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupResource" + }, { "target": "com.amazonaws.redshiftserverless#NamespaceResource" }, @@ -3939,7 +4118,7 @@ ], "aws.protocols#awsJson1_1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

This is an interface reference for Amazon Redshift Serverless. \n It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.\n

\n

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the \n underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high \n performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you\n focus on using your data to acquire new insights for your business and customers.\n

\n

\n To learn more about Amazon Redshift Serverless, \n see What is Amazon Redshift Serverless.\n

", + "smithy.api#documentation": "

This is an interface reference for Amazon Redshift Serverless. \n It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.\n

\n

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the \n underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high \n performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you\n focus on using your data to acquire new insights for your business and customers.\n

\n

To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless?.

", "smithy.api#title": "Redshift Serverless", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5230,7 +5409,7 @@ "schedule": { "target": "com.amazonaws.redshiftserverless#Schedule", "traits": { - "smithy.api#documentation": "

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

\n " + "smithy.api#documentation": "

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

\n " } }, "scheduledActionDescription": { @@ -5608,6 +5787,12 @@ ] } }, + "com.amazonaws.redshiftserverless#SourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z-]*:glue:[a-z0-9-]+:\\d+:(database|catalog)[a-z0-9-:]*(?:/[A-Za-z0-9-_]{1,255})*$" + } + }, "com.amazonaws.redshiftserverless#State": { "type": "string", "traits": { @@ -6271,7 +6456,7 @@ "schedule": { "target": "com.amazonaws.redshiftserverless#Schedule", "traits": { - "smithy.api#documentation": "

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

\n " + "smithy.api#documentation": "

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

\n " } }, "roleArn": { @@ -6545,7 +6730,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example,\n you can update baseCapacity or port in a single request, but you can't update both in the same request.

" + "smithy.api#documentation": "

Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example,\n you can update baseCapacity or port in a single request, but you can't update both in the same request.

\n

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that\n you own in a Region from reaching or being reached from the internet through internet\n gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA\n turned on, the following capabilities are blocked:

\n \n

For more information about VPC BPA, see Block public access to VPCs and\n subnets in the Amazon VPC User Guide.

" } }, "com.amazonaws.redshiftserverless#UpdateWorkgroupRequest": { diff --git a/codegen/sdk-codegen/aws-models/redshift.json b/codegen/sdk-codegen/aws-models/redshift.json index 85b79d2cfd3..428ffd004a5 100644 --- a/codegen/sdk-codegen/aws-models/redshift.json +++ b/codegen/sdk-codegen/aws-models/redshift.json @@ -2534,6 +2534,18 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.redshift#ConsumerIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.redshift#CopyClusterSnapshot": { "type": "operation", "input": { @@ -2784,7 +2796,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new cluster with the specified parameters.

\n

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster\n subnet group name. The cluster subnet group identifies the subnets of your VPC that\n Amazon Redshift uses when creating the cluster. \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Cluster Management Guide.

" + "smithy.api#documentation": "

Creates a new cluster with the specified parameters.

\n

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster\n subnet group name. The cluster subnet group identifies the subnets of your VPC that\n Amazon Redshift uses when creating the cluster. \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Cluster Management Guide.

\n

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that\n you own in a Region from reaching or being reached from the internet through internet\n gateways and egress-only internet gateways. If a subnet group for a\n provisioned cluster is in an account with VPC BPA turned on, the following capabilities\n are blocked:

\n \n

For more information about VPC BPA, see Block public access to VPCs and\n subnets in the Amazon VPC User Guide.

" } }, "com.amazonaws.redshift#CreateClusterMessage": { @@ -4529,6 +4541,12 @@ "traits": { "smithy.api#documentation": "

The identifier of a datashare to show its managing entity.

" } + }, + "DataShareType": { + "target": "com.amazonaws.redshift#DataShareType", + "traits": { + "smithy.api#documentation": "

The type of the datashare created by RegisterNamespace.

" + } } } }, @@ -4687,6 +4705,17 @@ } } }, + "com.amazonaws.redshift#DataShareType": { + "type": "enum", + "members": { + "INTERNAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL" + } + } + } + }, "com.amazonaws.redshift#DataTransferProgress": { "type": "structure", "members": { @@ -5736,6 +5765,67 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#DeregisterNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DeregisterNamespaceInputMessage" + }, + "output": { + "target": "com.amazonaws.redshift#DeregisterNamespaceOutputMessage" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.redshift#InvalidNamespaceFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.

" + } + }, + "com.amazonaws.redshift#DeregisterNamespaceInputMessage": { + "type": "structure", + "members": { + "NamespaceIdentifier": { + "target": "com.amazonaws.redshift#NamespaceIdentifierUnion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the cluster or \n serverless namespace that you want to deregister.

", + "smithy.api#required": {} + } + }, + "ConsumerIdentifiers": { + "target": "com.amazonaws.redshift#ConsumerIdentifierList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array containing the ID of the consumer account \n that you want to deregister the cluster or serverless namespace from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#DeregisterNamespaceOutputMessage": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.redshift#NamespaceRegistrationStatus", + "traits": { + "smithy.api#documentation": "

The registration status of the cluster or \n serverless namespace.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#DescribeAccountAttributes": { "type": "operation", "input": { @@ -11755,7 +11845,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the settings for a cluster.

\n

You can also change node type and the number of nodes to scale up or down the\n cluster. When resizing a cluster, you must specify both the number of nodes and the node\n type even if one of the parameters does not change.

\n

You can add another security or\n parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Cluster Management Guide.

" + "smithy.api#documentation": "

Modifies the settings for a cluster.

\n

You can also change node type and the number of nodes to scale up or down the\n cluster. When resizing a cluster, you must specify both the number of nodes and the node\n type even if one of the parameters does not change.

\n

You can add another security or\n parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Cluster Management Guide.

\n

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that\n you own in a Region from reaching or being reached from the internet through internet\n gateways and egress-only internet gateways. If a subnet group for a\n provisioned cluster is in an account with VPC BPA turned on, the following capabilities\n are blocked:

\n \n

For more information about VPC BPA, see Block public access to VPCs and\n subnets in the Amazon VPC User Guide.

" } }, "com.amazonaws.redshift#ModifyClusterDbRevision": { @@ -12345,7 +12435,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies a cluster subnet group to include the specified list of VPC subnets. The\n operation replaces the existing list of subnets with the new list of subnets.

" + "smithy.api#documentation": "

Modifies a cluster subnet group to include the specified list of VPC subnets. The\n operation replaces the existing list of subnets with the new list of subnets.

\n

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that\n you own in a Region from reaching or being reached from the internet through internet\n gateways and egress-only internet gateways. If a subnet group for a\n provisioned cluster is in an account with VPC BPA turned on, the following capabilities\n are blocked:

\n \n

For more information about VPC BPA, see Block public access to VPCs and\n subnets in the Amazon VPC User Guide.

" } }, "com.amazonaws.redshift#ModifyClusterSubnetGroupMessage": { @@ -13041,6 +13131,43 @@ "smithy.api#input": {} } }, + "com.amazonaws.redshift#NamespaceIdentifierUnion": { + "type": "union", + "members": { + "ServerlessIdentifier": { + "target": "com.amazonaws.redshift#ServerlessIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a serverless namespace.

" + } + }, + "ProvisionedIdentifier": { + "target": "com.amazonaws.redshift#ProvisionedIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a provisioned cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object to store union of values for a \n provisioned cluster or serverless namespace’s identifier.

" + } + }, + "com.amazonaws.redshift#NamespaceRegistrationStatus": { + "type": "enum", + "members": { + "REGISTERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Registering" + } + }, + "DEREGISTERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deregistering" + } + } + } + }, "com.amazonaws.redshift#NetworkInterface": { "type": "structure", "members": { @@ -13787,6 +13914,22 @@ "smithy.api#documentation": "

Describes cluster attributes that are in a pending state. A change to one or more\n the attributes was requested and is in progress or will be applied.

" } }, + "com.amazonaws.redshift#ProvisionedIdentifier": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for the provisioned cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The identifier for a provisioned cluster.

" + } + }, "com.amazonaws.redshift#PurchaseReservedNodeOffering": { "type": "operation", "input": { @@ -14440,6 +14583,9 @@ { "target": "com.amazonaws.redshift#DeleteUsageLimit" }, + { + "target": "com.amazonaws.redshift#DeregisterNamespace" + }, { "target": "com.amazonaws.redshift#DescribeAccountAttributes" }, @@ -14668,6 +14814,9 @@ { "target": "com.amazonaws.redshift#RebootCluster" }, + { + "target": "com.amazonaws.redshift#RegisterNamespace" + }, { "target": "com.amazonaws.redshift#RejectDataShare" }, @@ -15780,6 +15929,67 @@ } } }, + "com.amazonaws.redshift#RegisterNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#RegisterNamespaceInputMessage" + }, + "output": { + "target": "com.amazonaws.redshift#RegisterNamespaceOutputMessage" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.redshift#InvalidNamespaceFault" + } + ], + "traits": { + "smithy.api#documentation": "

Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.

" + } + }, + "com.amazonaws.redshift#RegisterNamespaceInputMessage": { + "type": "structure", + "members": { + "NamespaceIdentifier": { + "target": "com.amazonaws.redshift#NamespaceIdentifierUnion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the cluster or \n serverless namespace that you want to register.

", + "smithy.api#required": {} + } + }, + "ConsumerIdentifiers": { + "target": "com.amazonaws.redshift#ConsumerIdentifierList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An array containing the ID of the consumer account \n that you want to register the namespace to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#RegisterNamespaceOutputMessage": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.redshift#NamespaceRegistrationStatus", + "traits": { + "smithy.api#documentation": "

The registration status of the cluster or \n serverless namespace.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#RejectDataShare": { "type": "operation", "input": { @@ -16766,7 +16976,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting\n cluster with the same configuration as the original cluster from which the snapshot was\n created, except that the new cluster is created with the default cluster security and\n parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different\n parameter group with the restored cluster. If you are using a DS node type, you can also\n choose to change to another DS node type of the same size during restore.

\n

If you restore a cluster into a VPC, you must provide a cluster subnet group where\n you want the cluster restored.

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Cluster Management Guide.

" + "smithy.api#documentation": "

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting\n cluster with the same configuration as the original cluster from which the snapshot was\n created, except that the new cluster is created with the default cluster security and\n parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different\n parameter group with the restored cluster. If you are using a DS node type, you can also\n choose to change to another DS node type of the same size during restore.

\n

If you restore a cluster into a VPC, you must provide a cluster subnet group where\n you want the cluster restored.

\n

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that\n you own in a Region from reaching or being reached from the internet through internet\n gateways and egress-only internet gateways. If a subnet group for a\n provisioned cluster is in an account with VPC BPA turned on, the following capabilities\n are blocked:

\n \n

For more information about VPC BPA, see Block public access to VPCs and\n subnets in the Amazon VPC User Guide.

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Cluster Management Guide.

" } }, "com.amazonaws.redshift#RestoreFromClusterSnapshotMessage": { @@ -17975,6 +18185,30 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.redshift#ServerlessIdentifier": { + "type": "structure", + "members": { + "NamespaceIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for the serverless namespace.

", + "smithy.api#required": {} + } + }, + "WorkgroupIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for the workgroup \n associated with the serverless namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The identifier for a serverless namespace.

" + } + }, "com.amazonaws.redshift#ServiceAuthorization": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/s3.json b/codegen/sdk-codegen/aws-models/s3.json index 33682ef9644..e90ce50823c 100644 --- a/codegen/sdk-codegen/aws-models/s3.json +++ b/codegen/sdk-codegen/aws-models/s3.json @@ -266,6 +266,9 @@ { "target": "com.amazonaws.s3#CreateBucket" }, + { + "target": "com.amazonaws.s3#CreateBucketMetadataTableConfiguration" + }, { "target": "com.amazonaws.s3#CreateMultipartUpload" }, @@ -293,6 +296,9 @@ { "target": "com.amazonaws.s3#DeleteBucketLifecycle" }, + { + "target": "com.amazonaws.s3#DeleteBucketMetadataTableConfiguration" + }, { "target": "com.amazonaws.s3#DeleteBucketMetricsConfiguration" }, @@ -353,6 +359,9 @@ { "target": "com.amazonaws.s3#GetBucketLogging" }, + { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfiguration" + }, { "target": "com.amazonaws.s3#GetBucketMetricsConfiguration" }, @@ -20312,6 +20321,81 @@ "smithy.api#documentation": "

The configuration information for the bucket.

" } }, + "com.amazonaws.s3#CreateBucketMetadataTableConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CreateBucketMetadataTableConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "aws.protocols#httpChecksum": { + "requestAlgorithmMember": "ChecksumAlgorithm", + "requestChecksumRequired": true + }, + "smithy.api#documentation": "

Creates a metadata table configuration for a general purpose bucket. For more\n information, see Accelerating data\n discovery with S3 Metadata in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use this operation, you must have the following permissions. For more\n information, see Setting up\n permissions for configuring metadata tables in the\n Amazon S3 User Guide.

\n

If you also want to integrate your table bucket with Amazon Web Services analytics services so that you \n can query your metadata table, you need additional permissions. For more information, see \n \n Integrating Amazon S3 Tables with Amazon Web Services analytics services in the \n Amazon S3 User Guide.

\n
    \n
  • \n

    \n s3:CreateBucketMetadataTableConfiguration\n

    \n
    • \n
  • \n

    \n s3tables:CreateNamespace\n

    \n
    • \n
  • \n

    \n s3tables:GetTable\n

    \n
    • \n
  • \n

    \n s3tables:CreateTable\n

    \n
    • \n
  • \n

    \n s3tables:PutTablePolicy\n

    \n
    • \n
\n
\n
\n

The following operations are related to CreateBucketMetadataTableConfiguration:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}?metadataTable", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#CreateBucketMetadataTableConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

\n The general purpose bucket that you want to create the metadata table configuration in.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

\n The Content-MD5 header for the metadata table configuration.\n

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3#ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

\n The checksum algorithm to use with your metadata table configuration. \n

", + "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" + } + }, + "MetadataTableConfiguration": { + "target": "com.amazonaws.s3#MetadataTableConfiguration", + "traits": { + "smithy.api#documentation": "

\n The contents of your metadata table configuration. \n

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "MetadataTableConfiguration" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

\n The expected owner of the general purpose bucket that contains your metadata table configuration.\n

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.s3#CreateBucketOutput": { "type": "structure", "members": { @@ -21324,6 +21408,54 @@ "smithy.api#input": {} } }, + "com.amazonaws.s3#DeleteBucketMetadataTableConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketMetadataTableConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a metadata table configuration from a general purpose bucket. For more\n information, see Accelerating data\n discovery with S3 Metadata in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use this operation, you must have the s3:DeleteBucketMetadataTableConfiguration permission. For more\n information, see Setting up\n permissions for configuring metadata tables in the\n Amazon S3 User Guide.

\n
\n
\n

The following operations are related to DeleteBucketMetadataTableConfiguration:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?metadataTable", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#DeleteBucketMetadataTableConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

\n The general purpose bucket that you want to remove the metadata table configuration from.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

\n The expected bucket owner of the general purpose bucket that you want to remove the \n metadata table configuration from.\n

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.s3#DeleteBucketMetricsConfiguration": { "type": "operation", "input": { @@ -22462,6 +22594,26 @@ "com.amazonaws.s3#ErrorCode": { "type": "string" }, + "com.amazonaws.s3#ErrorDetails": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.s3#ErrorCode", + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error code. The possible error codes and \n error messages are as follows:\n

\n " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.s3#ErrorMessage", + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error message. The possible error codes and \n error messages are as follows:\n

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error code and error message.\n

" + } + }, "com.amazonaws.s3#ErrorDocument": { "type": "structure", "members": { @@ -23563,6 +23715,97 @@ "smithy.api#input": {} } }, + "com.amazonaws.s3#GetBucketMetadataTableConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

\n Retrieves the metadata table configuration for a general purpose bucket. For more\n information, see Accelerating data\n discovery with S3 Metadata in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use this operation, you must have the s3:GetBucketMetadataTableConfiguration permission. For more\n information, see Setting up\n permissions for configuring metadata tables in the\n Amazon S3 User Guide.

\n
\n
\n

The following operations are related to GetBucketMetadataTableConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?metadataTable", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3#GetBucketMetadataTableConfigurationOutput": { + "type": "structure", + "members": { + "GetBucketMetadataTableConfigurationResult": { + "target": "com.amazonaws.s3#GetBucketMetadataTableConfigurationResult", + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for the general purpose bucket.\n

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3#GetBucketMetadataTableConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

\n The general purpose bucket that contains the metadata table configuration that you want to retrieve.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Bucket" + } + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

\n The expected owner of the general purpose bucket that you want to retrieve the metadata table configuration from.\n

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3#GetBucketMetadataTableConfigurationResult": { + "type": "structure", + "members": { + "MetadataTableConfigurationResult": { + "target": "com.amazonaws.s3#MetadataTableConfigurationResult", + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket.\n

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.s3#MetadataTableStatus", + "traits": { + "smithy.api#documentation": "

\n The status of the metadata table. The status values are:\n

\n ", + "smithy.api#required": {} + } + }, + "Error": { + "target": "com.amazonaws.s3#ErrorDetails", + "traits": { + "smithy.api#documentation": "

\n If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was \n unable to create the table, this structure contains the error code and error message. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket.\n

" + } + }, "com.amazonaws.s3#GetBucketMetricsConfiguration": { "type": "operation", "input": { @@ -29226,6 +29469,39 @@ "com.amazonaws.s3#MetadataKey": { "type": "string" }, + "com.amazonaws.s3#MetadataTableConfiguration": { + "type": "structure", + "members": { + "S3TablesDestination": { + "target": "com.amazonaws.s3#S3TablesDestination", + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket.\n

" + } + }, + "com.amazonaws.s3#MetadataTableConfigurationResult": { + "type": "structure", + "members": { + "S3TablesDestinationResult": { + "target": "com.amazonaws.s3#S3TablesDestinationResult", + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metadata table configuration for a general purpose bucket. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket. \n

" + } + }, + "com.amazonaws.s3#MetadataTableStatus": { + "type": "string" + }, "com.amazonaws.s3#MetadataValue": { "type": "string" }, @@ -34234,6 +34510,76 @@ "smithy.api#documentation": "

Describes an Amazon S3 location that will receive the results of the restore request.

" } }, + "com.amazonaws.s3#S3TablesArn": { + "type": "string" + }, + "com.amazonaws.s3#S3TablesBucketArn": { + "type": "string" + }, + "com.amazonaws.s3#S3TablesDestination": { + "type": "structure", + "members": { + "TableBucketArn": { + "target": "com.amazonaws.s3#S3TablesBucketArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the table bucket that's specified as the \n destination in the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket.\n

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.s3#S3TablesName", + "traits": { + "smithy.api#documentation": "

\n The name for the metadata table in your metadata table configuration. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket. \n

" + } + }, + "com.amazonaws.s3#S3TablesDestinationResult": { + "type": "structure", + "members": { + "TableBucketArn": { + "target": "com.amazonaws.s3#S3TablesBucketArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the table bucket that's specified as the \n destination in the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket.\n

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.s3#S3TablesName", + "traits": { + "smithy.api#documentation": "

\n The name for the metadata table in your metadata table configuration. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

", + "smithy.api#required": {} + } + }, + "TableArn": { + "target": "com.amazonaws.s3#S3TablesArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The \n specified metadata table name must be unique within the aws_s3_metadata namespace \n in the destination table bucket.\n

", + "smithy.api#required": {} + } + }, + "TableNamespace": { + "target": "com.amazonaws.s3#S3TablesNamespace", + "traits": { + "smithy.api#documentation": "

\n The table bucket namespace for the metadata table in your metadata table configuration. This value \n is always aws_s3_metadata.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The destination information for the metadata table configuration. The destination table bucket\n must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata\n table name must be unique within the aws_s3_metadata namespace in the destination \n table bucket.\n

" + } + }, + "com.amazonaws.s3#S3TablesName": { + "type": "string" + }, + "com.amazonaws.s3#S3TablesNamespace": { + "type": "string" + }, "com.amazonaws.s3#SSECustomerAlgorithm": { "type": "string" }, diff --git a/codegen/sdk-codegen/aws-models/s3tables.json b/codegen/sdk-codegen/aws-models/s3tables.json new file mode 100644 index 00000000000..4df7bd1e8ee --- /dev/null +++ b/codegen/sdk-codegen/aws-models/s3tables.json @@ -0,0 +1,3882 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.s3tables#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.s3tables#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The action cannot be performed because you do not have the required permission.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.s3tables#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9].*$" + } + }, + "com.amazonaws.s3tables#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.s3tables#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request is invalid or malformed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.s3tables#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.s3tables#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because there is a conflict with a previous write. You can retry the\n request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.s3tables#CreateNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#CreateNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#CreateNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see Table namespaces.

", + "smithy.api#http": { + "uri": "/namespaces/{tableBucketARN}", + "method": "PUT", + "code": 200 + } + } + }, + "com.amazonaws.s3tables#CreateNamespaceRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket to create the namespace in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceList", + "traits": { + "smithy.api#documentation": "

A name for the namespace.

", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#CreateNamespaceResponse": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket the namespace was created in.

", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceList", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#CreateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#CreateTableRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#CreateTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new table associated with the given namespace in a table bucket.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}", + "method": "PUT", + "code": 200 + } + } + }, + "com.amazonaws.s3tables#CreateTableBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#CreateTableBucketRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#CreateTableBucketResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a table bucket.

", + "smithy.api#http": { + "uri": "/buckets", + "method": "PUT", + "code": 200 + } + } + }, + "com.amazonaws.s3tables#CreateTableBucketRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.s3tables#TableBucketName", + "traits": { + "smithy.api#documentation": "

The name for the table bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#CreateTableBucketResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#CreateTableRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket to create the table in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace to associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name for the table.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.s3tables#OpenTableFormat", + "traits": { + "smithy.api#documentation": "

The format for the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#CreateTableResponse": { + "type": "structure", + "members": { + "tableARN": { + "target": "com.amazonaws.s3tables#TableARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table.

", + "smithy.api#required": {} + } + }, + "versionToken": { + "target": "com.amazonaws.s3tables#VersionToken", + "traits": { + "smithy.api#documentation": "

The version token of the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#DeleteNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#DeleteNamespaceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a namespace.

", + "smithy.api#http": { + "uri": "/namespaces/{tableBucketARN}/{namespace}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#DeleteNamespaceRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket associated with the namespace.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#DeleteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#DeleteTableRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a table.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#DeleteTableBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#DeleteTableBucketRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a table bucket.

", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#DeleteTableBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#DeleteTableBucketPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a table bucket policy.

", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/policy", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#DeleteTableBucketPolicyRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#DeleteTableBucketRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#DeleteTablePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#DeleteTablePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a table policy.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/policy", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#DeleteTablePolicyRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table bucket that contains the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The table name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#DeleteTableRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket that contains the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionToken": { + "target": "com.amazonaws.s3tables#VersionToken", + "traits": { + "smithy.api#documentation": "

The version token of the table.

", + "smithy.api#httpQuery": "versionToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.s3tables#ForbiddenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.s3tables#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The caller isn't authorized to make the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.s3tables#GetNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a namespace.

", + "smithy.api#http": { + "uri": "/namespaces/{tableBucketARN}/{namespace}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetNamespace_AccessDeniedException", + "params": { + "tableBucketARN": "arn:aws:s3tables:us-east-1:123456789012:bucket/does-not-exist", + "namespace": "doesnotexist" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.s3tables#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.s3tables#GetNamespaceRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetNamespaceResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceList", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the namespace was created at.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "createdBy": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that created the namespace.

", + "smithy.api#required": {} + } + }, + "ownerAccountId": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that owns the namespcace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a table.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetTable_AccessDeniedException", + "params": { + "tableBucketARN": "arn:aws:s3tables:us-east-1:123456789012:bucket/does-not-exist", + "namespace": "doesnotexist", + "name": "doesnotexist" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.s3tables#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.s3tables#GetTableBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableBucketRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableBucketResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details on a table bucket.

", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetTableBucket_AccessDeniedException", + "params": { + "tableBucketARN": "arn:aws:s3tables:us-east-1:123456789012:bucket/does-not-exist" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.s3tables#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.s3tables#GetTableBucketMaintenanceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableBucketMaintenanceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableBucketMaintenanceConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a maintenance configuration for a given table bucket.

", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/maintenance", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketMaintenanceConfigurationRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket associated with the maintenance\n configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketMaintenanceConfigurationResponse": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket associated with the maintenance\n configuration.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.s3tables#TableBucketMaintenanceConfiguration", + "traits": { + "smithy.api#documentation": "

Details about the maintenance configuration for the table bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableBucketPolicyRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableBucketPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a table bucket policy.

", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/policy", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketPolicyRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketPolicyResponse": { + "type": "structure", + "members": { + "resourcePolicy": { + "target": "com.amazonaws.s3tables#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableBucketName", + "traits": { + "smithy.api#documentation": "

The name of the table bucket

", + "smithy.api#required": {} + } + }, + "ownerAccountId": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that owns the table bucket.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the table bucket was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTableMaintenanceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableMaintenanceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableMaintenanceConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about the maintenance configuration of a table.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/maintenance", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTableMaintenanceConfigurationRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableMaintenanceConfigurationResponse": { + "type": "structure", + "members": { + "tableARN": { + "target": "com.amazonaws.s3tables#TableARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.s3tables#TableMaintenanceConfiguration", + "traits": { + "smithy.api#documentation": "

Details about the maintenance configuration for the table bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTableMaintenanceJobStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableMaintenanceJobStatusRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableMaintenanceJobStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the status of a maintenance job for a table.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/maintenance-job-status", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTableMaintenanceJobStatusRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace the table is associated with.\n \n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the maintenance job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableMaintenanceJobStatusResponse": { + "type": "structure", + "members": { + "tableARN": { + "target": "com.amazonaws.s3tables#TableARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.s3tables#TableMaintenanceJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the maintenance job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTableMetadataLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableMetadataLocationRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableMetadataLocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the location of the table metadata.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/metadata-location", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTableMetadataLocationRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableMetadataLocationResponse": { + "type": "structure", + "members": { + "versionToken": { + "target": "com.amazonaws.s3tables#VersionToken", + "traits": { + "smithy.api#documentation": "

The version token.

", + "smithy.api#required": {} + } + }, + "metadataLocation": { + "target": "com.amazonaws.s3tables#MetadataLocation", + "traits": { + "smithy.api#documentation": "

The metadata location.

" + } + }, + "warehouseLocation": { + "target": "com.amazonaws.s3tables#WarehouseLocation", + "traits": { + "smithy.api#documentation": "

The warehouse location.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTablePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTablePolicyRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTablePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a table policy.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/policy", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTablePolicyRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table bucket that contains the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTablePolicyResponse": { + "type": "structure", + "members": { + "resourcePolicy": { + "target": "com.amazonaws.s3tables#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTableRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace the table is associated with.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.s3tables#TableType", + "traits": { + "smithy.api#documentation": "

The type of the table.

", + "smithy.api#required": {} + } + }, + "tableARN": { + "target": "com.amazonaws.s3tables#TableARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table.

", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceList", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#required": {} + } + }, + "versionToken": { + "target": "com.amazonaws.s3tables#VersionToken", + "traits": { + "smithy.api#documentation": "

The version token of the table.

", + "smithy.api#required": {} + } + }, + "metadataLocation": { + "target": "com.amazonaws.s3tables#MetadataLocation", + "traits": { + "smithy.api#documentation": "

The metadata location of the table.

" + } + }, + "warehouseLocation": { + "target": "com.amazonaws.s3tables#WarehouseLocation", + "traits": { + "smithy.api#documentation": "

The warehouse location of the table.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the table bucket was created at.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "createdBy": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that created the table.

", + "smithy.api#required": {} + } + }, + "managedByService": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The service that manages the table.

" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the table was last modified on.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedBy": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that last modified the table.

", + "smithy.api#required": {} + } + }, + "ownerAccountId": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that owns the table.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.s3tables#OpenTableFormat", + "traits": { + "smithy.api#documentation": "

The format of the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#IcebergCompactionSettings": { + "type": "structure", + "members": { + "targetFileSizeMB": { + "target": "com.amazonaws.s3tables#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The target file size for the table in MB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the compaction settings for an Iceberg table. \n

" + } + }, + "com.amazonaws.s3tables#IcebergSnapshotManagementSettings": { + "type": "structure", + "members": { + "minSnapshotsToKeep": { + "target": "com.amazonaws.s3tables#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The minimum number of snapshots to keep.

" + } + }, + "maxSnapshotAgeHours": { + "target": "com.amazonaws.s3tables#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum age of a snapshot before it can be expired.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the snapshot management settings for an Iceberg table. The oldest snapshot expires when its age exceeds the maxSnapshotAgeHours and the total number of snapshots exceeds the value for the minimum number of snapshots to keep minSnapshotsToKeep.\n

" + } + }, + "com.amazonaws.s3tables#IcebergUnreferencedFileRemovalSettings": { + "type": "structure", + "members": { + "unreferencedDays": { + "target": "com.amazonaws.s3tables#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of days an object has to be unreferenced before it is marked as non-current.\n\n

" + } + }, + "nonCurrentDays": { + "target": "com.amazonaws.s3tables#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of days an object has to be non-current before it is deleted.\n \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the unreferenced file removal settings for an Iceberg table bucket. \n

" + } + }, + "com.amazonaws.s3tables#InternalServerErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.s3tables#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request failed due to an internal server error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.s3tables#JobStatus": { + "type": "enum", + "members": { + "NOT_YET_RUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Not_Yet_Run" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3tables#ListNamespaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#ListNamespacesRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#ListNamespacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the namespaces within a table bucket.

", + "smithy.api#http": { + "uri": "/namespaces/{tableBucketARN}", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "continuationToken", + "outputToken": "continuationToken", + "pageSize": "maxNamespaces", + "items": "namespaces" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListNamespaces_AccessDeniedException", + "params": { + "tableBucketARN": "arn:aws:s3tables:us-east-1:123456789012:bucket/does-not-exist" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.s3tables#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.s3tables#ListNamespacesLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.s3tables#ListNamespacesRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "prefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The prefix of the namespaces.

", + "smithy.api#httpQuery": "prefix", + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "continuationToken": { + "target": "com.amazonaws.s3tables#NextToken", + "traits": { + "smithy.api#documentation": "

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken is obfuscated and is not a real key.\n You can use this ContinuationToken for pagination of the list results.

", + "smithy.api#httpQuery": "continuationToken" + } + }, + "maxNamespaces": { + "target": "com.amazonaws.s3tables#ListNamespacesLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of namespaces to return in the list.

", + "smithy.api#httpQuery": "maxNamespaces" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#ListNamespacesResponse": { + "type": "structure", + "members": { + "namespaces": { + "target": "com.amazonaws.s3tables#NamespaceSummaryList", + "traits": { + "smithy.api#documentation": "

A list of namespaces.

", + "smithy.api#required": {} + } + }, + "continuationToken": { + "target": "com.amazonaws.s3tables#NextToken", + "traits": { + "smithy.api#documentation": "

The ContinuationToken for pagination of the list results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#ListTableBuckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#ListTableBucketsRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#ListTableBucketsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists table buckets for your account.

", + "smithy.api#http": { + "uri": "/buckets", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "continuationToken", + "outputToken": "continuationToken", + "pageSize": "maxBuckets", + "items": "tableBuckets" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListTableBuckets_Success", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.s3tables#ListTableBucketsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.s3tables#ListTableBucketsRequest": { + "type": "structure", + "members": { + "prefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The prefix of the table buckets.

", + "smithy.api#httpQuery": "prefix", + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "continuationToken": { + "target": "com.amazonaws.s3tables#NextToken", + "traits": { + "smithy.api#documentation": "

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken is obfuscated and is not a real key.\n You can use this ContinuationToken for pagination of the list results.

", + "smithy.api#httpQuery": "continuationToken" + } + }, + "maxBuckets": { + "target": "com.amazonaws.s3tables#ListTableBucketsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of table buckets to return in the list.

", + "smithy.api#httpQuery": "maxBuckets" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#ListTableBucketsResponse": { + "type": "structure", + "members": { + "tableBuckets": { + "target": "com.amazonaws.s3tables#TableBucketSummaryList", + "traits": { + "smithy.api#documentation": "

A list of table buckets.

", + "smithy.api#required": {} + } + }, + "continuationToken": { + "target": "com.amazonaws.s3tables#NextToken", + "traits": { + "smithy.api#documentation": "

You can use this ContinuationToken for pagination of the list results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#ListTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#ListTablesRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#ListTablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

List tables in the given table bucket.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "continuationToken", + "outputToken": "continuationToken", + "pageSize": "maxTables", + "items": "tables" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetTable_AccessDeniedException", + "params": { + "tableBucketARN": "arn:aws:s3tables:us-east-1:123456789012:bucket/does-not-exist" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.s3tables#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.s3tables#ListTablesLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.s3tables#ListTablesRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon resource Number (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace of the tables.

", + "smithy.api#httpQuery": "namespace" + } + }, + "prefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The prefix of the tables.

", + "smithy.api#httpQuery": "prefix", + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "continuationToken": { + "target": "com.amazonaws.s3tables#NextToken", + "traits": { + "smithy.api#documentation": "

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken is obfuscated and is not a real key.\n You can use this ContinuationToken for pagination of the list results.

", + "smithy.api#httpQuery": "continuationToken" + } + }, + "maxTables": { + "target": "com.amazonaws.s3tables#ListTablesLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of tables to return.

", + "smithy.api#httpQuery": "maxTables" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#ListTablesResponse": { + "type": "structure", + "members": { + "tables": { + "target": "com.amazonaws.s3tables#TableSummaryList", + "traits": { + "smithy.api#documentation": "

A list of tables.

", + "smithy.api#required": {} + } + }, + "continuationToken": { + "target": "com.amazonaws.s3tables#NextToken", + "traits": { + "smithy.api#documentation": "

You can use this ContinuationToken for pagination of the list results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#MaintenanceStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.s3tables#MetadataLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.s3tables#NamespaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3tables#NamespaceName" + } + }, + "com.amazonaws.s3tables#NamespaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[0-9a-z_]*$" + } + }, + "com.amazonaws.s3tables#NamespaceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.s3tables#CreateNamespace" + }, + { + "target": "com.amazonaws.s3tables#DeleteNamespace" + }, + { + "target": "com.amazonaws.s3tables#GetNamespace" + }, + { + "target": "com.amazonaws.s3tables#ListNamespaces" + } + ] + }, + "com.amazonaws.s3tables#NamespaceSummary": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceList", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the namespace was created at.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "createdBy": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that created the namespace.

", + "smithy.api#required": {} + } + }, + "ownerAccountId": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that owns the namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a namespace.

" + } + }, + "com.amazonaws.s3tables#NamespaceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3tables#NamespaceSummary" + } + }, + "com.amazonaws.s3tables#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.s3tables#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.s3tables#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because the specified resource could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.s3tables#OpenTableFormat": { + "type": "enum", + "members": { + "ICEBERG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ICEBERG" + } + } + } + }, + "com.amazonaws.s3tables#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2147483647 + } + } + }, + "com.amazonaws.s3tables#PutTableBucketMaintenanceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#PutTableBucketMaintenanceConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing maintenance configuration\n for a table bucket.

", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/maintenance/{type}", + "method": "PUT", + "code": 204 + } + } + }, + "com.amazonaws.s3tables#PutTableBucketMaintenanceConfigurationRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket associated with the maintenance\n configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.s3tables#TableBucketMaintenanceType", + "traits": { + "smithy.api#documentation": "

The type of the maintenance configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.s3tables#TableBucketMaintenanceConfigurationValue", + "traits": { + "smithy.api#documentation": "

Defines the values of the maintenance configuration for the table bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#PutTableBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#PutTableBucketPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing table bucket policy for a\n table bucket.

", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/policy", + "method": "PUT", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#PutTableBucketPolicyRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourcePolicy": { + "target": "com.amazonaws.s3tables#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#PutTableMaintenanceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#PutTableMaintenanceConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing maintenance configuration\n for a table.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/maintenance/{type}", + "method": "PUT", + "code": 204 + } + } + }, + "com.amazonaws.s3tables#PutTableMaintenanceConfigurationRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table associated with the maintenance\n configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the maintenance configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.s3tables#TableMaintenanceType", + "traits": { + "smithy.api#documentation": "

The type of the maintenance configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.s3tables#TableMaintenanceConfigurationValue", + "traits": { + "smithy.api#documentation": "

Defines the values of the maintenance configuration for the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#PutTablePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#PutTablePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new maintenance configuration or replaces an existing table policy for a table.\n

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/policy", + "method": "PUT", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#PutTablePolicyRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table bucket that contains the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourcePolicy": { + "target": "com.amazonaws.s3tables#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The name of the resource policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#RenameTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#RenameTableRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Renames a table or a namespace.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/rename", + "method": "PUT", + "code": 204 + } + } + }, + "com.amazonaws.s3tables#RenameTableRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The current name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "newNamespaceName": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The new name for the namespace.

" + } + }, + "newName": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The new name for the table.

" + } + }, + "versionToken": { + "target": "com.amazonaws.s3tables#VersionToken", + "traits": { + "smithy.api#documentation": "

The version token of the table.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + } + } + }, + "com.amazonaws.s3tables#S3TableBuckets": { + "type": "service", + "version": "2018-05-10", + "resources": [ + { + "target": "com.amazonaws.s3tables#NamespaceResource" + }, + { + "target": "com.amazonaws.s3tables#TableBucketPolicyResource" + }, + { + "target": "com.amazonaws.s3tables#TableBucketResource" + }, + { + "target": "com.amazonaws.s3tables#TablePolicyResource" + }, + { + "target": "com.amazonaws.s3tables#TableResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "S3Tables", + "arnNamespace": "s3tables", + "cloudTrailEventSource": "s3tables.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "s3tables" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

An Amazon S3 table represents a structured dataset consisting of tabular data in Apache Parquet format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the Apache Iceberg table format. Through integration with the AWS Glue Data Catalog you can interact with your tables using AWS analytics services, such as Amazon Athena and Amazon Redshift. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see Amazon S3 table buckets.

", + "smithy.api#title": "Amazon S3 Tables", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3tables-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3tables-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3tables.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://s3tables.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://s3tables.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://s3tables.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://s3tables.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://s3tables.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.s3tables#TableARN": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::S3Tables::Table" + }, + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})$" + } + }, + "com.amazonaws.s3tables#TableBucketARN": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::S3Tables::TableBucket" + }, + "smithy.api#pattern": "^(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})$" + } + }, + "com.amazonaws.s3tables#TableBucketMaintenanceConfiguration": { + "type": "map", + "key": { + "target": "com.amazonaws.s3tables#TableBucketMaintenanceType" + }, + "value": { + "target": "com.amazonaws.s3tables#TableBucketMaintenanceConfigurationValue" + } + }, + "com.amazonaws.s3tables#TableBucketMaintenanceConfigurationValue": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.s3tables#MaintenanceStatus", + "traits": { + "smithy.api#documentation": "

The status of the maintenance configuration.

" + } + }, + "settings": { + "target": "com.amazonaws.s3tables#TableBucketMaintenanceSettings", + "traits": { + "smithy.api#documentation": "

Contains details about the settings of the maintenance configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the values that define the maintenance configuration for a table bucket.

" + } + }, + "com.amazonaws.s3tables#TableBucketMaintenanceSettings": { + "type": "union", + "members": { + "icebergUnreferencedFileRemoval": { + "target": "com.amazonaws.s3tables#IcebergUnreferencedFileRemovalSettings", + "traits": { + "smithy.api#documentation": "

The unreferenced file removal settings for the table bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the maintenance settings for the table bucket.

" + } + }, + "com.amazonaws.s3tables#TableBucketMaintenanceType": { + "type": "enum", + "members": { + "ICEBERG_UNREFERENCED_FILE_REMOVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icebergUnreferencedFileRemoval" + } + } + } + }, + "com.amazonaws.s3tables#TableBucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-z-]*$" + } + }, + "com.amazonaws.s3tables#TableBucketPolicyResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.s3tables#DeleteTableBucketPolicy" + }, + { + "target": "com.amazonaws.s3tables#GetTableBucketPolicy" + }, + { + "target": "com.amazonaws.s3tables#PutTableBucketPolicy" + } + ] + }, + "com.amazonaws.s3tables#TableBucketResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.s3tables#CreateTableBucket" + }, + { + "target": "com.amazonaws.s3tables#DeleteTableBucket" + }, + { + "target": "com.amazonaws.s3tables#GetTableBucket" + }, + { + "target": "com.amazonaws.s3tables#GetTableBucketMaintenanceConfiguration" + }, + { + "target": "com.amazonaws.s3tables#ListTableBuckets" + }, + { + "target": "com.amazonaws.s3tables#PutTableBucketMaintenanceConfiguration" + } + ], + "traits": { + "aws.api#arn": { + "absolute": true, + "template": "com.amazonaws.s3tables#TableBucketARN" + } + } + }, + "com.amazonaws.s3tables#TableBucketSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table bucket.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableBucketName", + "traits": { + "smithy.api#documentation": "

The name of the table bucket.

", + "smithy.api#required": {} + } + }, + "ownerAccountId": { + "target": "com.amazonaws.s3tables#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that owns the table bucket.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the table bucket was created at.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a table bucket.

" + } + }, + "com.amazonaws.s3tables#TableBucketSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3tables#TableBucketSummary" + } + }, + "com.amazonaws.s3tables#TableMaintenanceConfiguration": { + "type": "map", + "key": { + "target": "com.amazonaws.s3tables#TableMaintenanceType" + }, + "value": { + "target": "com.amazonaws.s3tables#TableMaintenanceConfigurationValue" + } + }, + "com.amazonaws.s3tables#TableMaintenanceConfigurationValue": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.s3tables#MaintenanceStatus", + "traits": { + "smithy.api#documentation": "

The status of the maintenance configuration.

" + } + }, + "settings": { + "target": "com.amazonaws.s3tables#TableMaintenanceSettings", + "traits": { + "smithy.api#documentation": "

Contains details about the settings for the maintenance configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the values that define a maintenance configuration for a table.

" + } + }, + "com.amazonaws.s3tables#TableMaintenanceJobStatus": { + "type": "map", + "key": { + "target": "com.amazonaws.s3tables#TableMaintenanceJobType" + }, + "value": { + "target": "com.amazonaws.s3tables#TableMaintenanceJobStatusValue" + } + }, + "com.amazonaws.s3tables#TableMaintenanceJobStatusValue": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.s3tables#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "lastRunTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the maintenance job was last run.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The failure message of a failed job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the status of a maintenance job.

" + } + }, + "com.amazonaws.s3tables#TableMaintenanceJobType": { + "type": "enum", + "members": { + "ICEBERG_COMPACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icebergCompaction" + } + }, + "ICEBERG_SNAPSHOT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icebergSnapshotManagement" + } + }, + "ICEBERG_UNREFERENCED_FILE_REMOVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icebergUnreferencedFileRemoval" + } + } + } + }, + "com.amazonaws.s3tables#TableMaintenanceSettings": { + "type": "union", + "members": { + "icebergCompaction": { + "target": "com.amazonaws.s3tables#IcebergCompactionSettings", + "traits": { + "smithy.api#documentation": "

Contains details about the Iceberg compaction settings for the table.

" + } + }, + "icebergSnapshotManagement": { + "target": "com.amazonaws.s3tables#IcebergSnapshotManagementSettings", + "traits": { + "smithy.api#documentation": "

Contains details about the Iceberg snapshot management settings for the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about maintenance settings for the table.

" + } + }, + "com.amazonaws.s3tables#TableMaintenanceType": { + "type": "enum", + "members": { + "ICEBERG_COMPACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icebergCompaction" + } + }, + "ICEBERG_SNAPSHOT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icebergSnapshotManagement" + } + } + } + }, + "com.amazonaws.s3tables#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[0-9a-z_]*$" + } + }, + "com.amazonaws.s3tables#TablePolicyResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.s3tables#DeleteTablePolicy" + }, + { + "target": "com.amazonaws.s3tables#GetTablePolicy" + }, + { + "target": "com.amazonaws.s3tables#PutTablePolicy" + } + ] + }, + "com.amazonaws.s3tables#TableResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.s3tables#CreateTable" + }, + { + "target": "com.amazonaws.s3tables#DeleteTable" + }, + { + "target": "com.amazonaws.s3tables#GetTable" + }, + { + "target": "com.amazonaws.s3tables#GetTableMaintenanceConfiguration" + }, + { + "target": "com.amazonaws.s3tables#GetTableMaintenanceJobStatus" + }, + { + "target": "com.amazonaws.s3tables#GetTableMetadataLocation" + }, + { + "target": "com.amazonaws.s3tables#ListTables" + }, + { + "target": "com.amazonaws.s3tables#PutTableMaintenanceConfiguration" + }, + { + "target": "com.amazonaws.s3tables#RenameTable" + }, + { + "target": "com.amazonaws.s3tables#UpdateTableMetadataLocation" + } + ], + "traits": { + "aws.api#arn": { + "absolute": true, + "template": "com.amazonaws.s3tables#TableARN" + } + } + }, + "com.amazonaws.s3tables#TableSummary": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceList", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.s3tables#TableType", + "traits": { + "smithy.api#documentation": "

The type of the table.

", + "smithy.api#required": {} + } + }, + "tableARN": { + "target": "com.amazonaws.s3tables#TableARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the table was created at.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the table was last modified at.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a table.

" + } + }, + "com.amazonaws.s3tables#TableSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3tables#TableSummary" + } + }, + "com.amazonaws.s3tables#TableType": { + "type": "enum", + "members": { + "CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "customer" + } + }, + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws" + } + } + } + }, + "com.amazonaws.s3tables#TooManyRequestsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.s3tables#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.s3tables#UpdateTableMetadataLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#UpdateTableMetadataLocationRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#UpdateTableMetadataLocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the metadata location for a table.

", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/metadata-location", + "method": "PUT" + } + } + }, + "com.amazonaws.s3tables#UpdateTableMetadataLocationRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionToken": { + "target": "com.amazonaws.s3tables#VersionToken", + "traits": { + "smithy.api#documentation": "

The version token of the table.

", + "smithy.api#required": {} + } + }, + "metadataLocation": { + "target": "com.amazonaws.s3tables#MetadataLocation", + "traits": { + "smithy.api#documentation": "

The new metadata location for the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#UpdateTableMetadataLocationResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "tableARN": { + "target": "com.amazonaws.s3tables#TableARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table.

", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceList", + "traits": { + "smithy.api#documentation": "

The namespace the table is associated with.

", + "smithy.api#required": {} + } + }, + "versionToken": { + "target": "com.amazonaws.s3tables#VersionToken", + "traits": { + "smithy.api#documentation": "

The version token of the table.

", + "smithy.api#required": {} + } + }, + "metadataLocation": { + "target": "com.amazonaws.s3tables#MetadataLocation", + "traits": { + "smithy.api#documentation": "

The metadata location of the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#VersionToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.s3tables#WarehouseLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + } + } +} \ No newline at end of file