From 7720f87d0ec2f3609e2912c864b6f9ae550e0792 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Fri, 17 Nov 2023 20:05:35 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/app-mesh.json | 251 +- codegen/sdk-codegen/aws-models/athena.json | 108 +- codegen/sdk-codegen/aws-models/cloud9.json | 3 +- .../aws-models/cloudformation.json | 70 +- .../sdk-codegen/aws-models/codepipeline.json | 82 +- .../aws-models/codestar-connections.json | 2777 ++++++++++-- codegen/sdk-codegen/aws-models/connect.json | 12 +- codegen/sdk-codegen/aws-models/dlm.json | 4 +- codegen/sdk-codegen/aws-models/ec2.json | 1433 +++++- codegen/sdk-codegen/aws-models/ecr.json | 460 +- codegen/sdk-codegen/aws-models/emr.json | 183 +- .../sdk-codegen/aws-models/eventbridge.json | 137 +- .../aws-models/internetmonitor.json | 590 ++- codegen/sdk-codegen/aws-models/ivs.json | 53 +- codegen/sdk-codegen/aws-models/ivschat.json | 69 +- .../sdk-codegen/aws-models/kinesis-video.json | 52 +- codegen/sdk-codegen/aws-models/location.json | 83 +- codegen/sdk-codegen/aws-models/medialive.json | 169 +- codegen/sdk-codegen/aws-models/mgn.json | 73 +- codegen/sdk-codegen/aws-models/osis.json | 194 +- codegen/sdk-codegen/aws-models/pipes.json | 6 - codegen/sdk-codegen/aws-models/rds.json | 66 +- .../aws-models/redshift-serverless.json | 15 + codegen/sdk-codegen/aws-models/redshift.json | 599 +++ codegen/sdk-codegen/aws-models/s3.json | 735 +--- codegen/sdk-codegen/aws-models/sso-admin.json | 48 +- codegen/sdk-codegen/aws-models/sso-oidc.json | 539 ++- codegen/sdk-codegen/aws-models/sts.json | 236 +- .../aws-models/trustedadvisor.json | 3863 +++++++++++++++++ .../aws-models/verifiedpermissions.json | 171 +- codegen/sdk-codegen/aws-models/wisdom.json | 2501 ++++++++++- 31 files changed, 13676 insertions(+), 1906 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/trustedadvisor.json diff --git a/codegen/sdk-codegen/aws-models/app-mesh.json b/codegen/sdk-codegen/aws-models/app-mesh.json index 0f90d11fa5d..e52e251101a 100644 --- a/codegen/sdk-codegen/aws-models/app-mesh.json +++ b/codegen/sdk-codegen/aws-models/app-mesh.json @@ -48,8 +48,7 @@ "sdkId": "App Mesh", "arnNamespace": "appmesh", "cloudFormationName": "AppMesh", - "cloudTrailEventSource": "appmesh.amazonaws.com", - "endpointPrefix": "appmesh" + "cloudTrailEventSource": "appmesh.amazonaws.com" }, "aws.auth#sigv4": { "name": "appmesh" @@ -100,7 +99,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -143,7 +141,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -156,7 +155,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -170,7 +168,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -193,7 +190,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -228,7 +224,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -239,14 +234,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -260,14 +257,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -276,11 +271,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -291,14 +286,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -312,7 +309,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -332,7 +328,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -343,14 +338,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -361,9 +358,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1479,9 +1478,8 @@ "traits": { "smithy.api#documentation": "

Creates a gateway route.

\n

A gateway route is attached to a virtual gateway and routes traffic to an existing\n virtual service. If a route matches a request, it can distribute traffic to a target\n virtual service.

\n

For more information about gateway routes, see Gateway routes.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -1591,9 +1589,8 @@ "traits": { "smithy.api#documentation": "

Creates a service mesh.

\n

A service mesh is a logical boundary for network traffic between services that are\n represented by resources within the mesh. After you create your service mesh, you can\n create virtual services, virtual nodes, virtual routers, and routes to distribute traffic\n between the applications in your mesh.

\n

For more information about service meshes, see Service meshes.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -1688,9 +1685,8 @@ "traits": { "smithy.api#documentation": "

Creates a route that is associated with a virtual router.

\n

You can route several different protocols and define a retry policy for a route.\n Traffic can be routed to one or more virtual nodes.

\n

For more information about routes, see Routes.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -1809,9 +1805,8 @@ "traits": { "smithy.api#documentation": "

Creates a virtual gateway.

\n

A virtual gateway allows resources outside your mesh to communicate to resources that\n are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a\n virtual node, which represents an Envoy running with an application, a virtual gateway\n represents Envoy deployed by itself.

\n

For more information about virtual gateways, see Virtual gateways.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualGateways", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -1913,9 +1908,8 @@ "traits": { "smithy.api#documentation": "

Creates a virtual node within a service mesh.

\n

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can\n specify the service discovery information for your task group, and whether the proxy\n running in a task group will communicate with other proxies using Transport Layer Security\n (TLS).

\n

You define a listener for any inbound traffic that your virtual node\n expects. Any virtual service that your virtual node expects to communicate to is specified\n as a backend.

\n

The response metadata for your new virtual node contains the arn that is\n associated with the virtual node. Set this value to the full ARN; for example,\n arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp)\n as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n node.id and node.cluster Envoy parameters.

\n \n

By default, App Mesh uses the name of the resource you specified in\n APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and\n traces. You can override this behavior by setting the\n APPMESH_RESOURCE_CLUSTER environment variable with your own name.

\n \n

For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when\n setting these variables. For more information aboutApp Mesh Envoy variables, see\n Envoy\n image in the App Mesh User Guide.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualNodes", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -2026,9 +2020,8 @@ "traits": { "smithy.api#documentation": "

Creates a virtual router within a service mesh.

\n

Specify a listener for any inbound traffic that your virtual router\n receives. Create a virtual router for each protocol and port that you need to route.\n Virtual routers handle traffic for one or more virtual services within your mesh. After you\n create your virtual router, create and associate routes for your virtual router that direct\n incoming requests to different virtual nodes.

\n

For more information about virtual routers, see Virtual routers.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualRouters", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -2139,9 +2132,8 @@ "traits": { "smithy.api#documentation": "

Creates a virtual service within a service mesh.

\n

A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its virtualServiceName, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.

\n

For more information about virtual services, see Virtual services.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualServices", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -2264,9 +2256,8 @@ "traits": { "smithy.api#documentation": "

Deletes an existing gateway route.

", "smithy.api#http": { - "method": "DELETE", "uri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2354,9 +2345,8 @@ "traits": { "smithy.api#documentation": "

Deletes an existing service mesh.

\n

You must delete all resources (virtual services, routes, virtual routers, and virtual\n nodes) in the service mesh before you can delete the mesh itself.

", "smithy.api#http": { - "method": "DELETE", "uri": "/v20190125/meshes/{meshName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2427,9 +2417,8 @@ "traits": { "smithy.api#documentation": "

Deletes an existing route.

", "smithy.api#http": { - "method": "DELETE", "uri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2523,9 +2512,8 @@ "traits": { "smithy.api#documentation": "

Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway\n routes are associated to it.

", "smithy.api#http": { - "method": "DELETE", "uri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2605,9 +2593,8 @@ "traits": { "smithy.api#documentation": "

Deletes an existing virtual node.

\n

You must delete any virtual services that list a virtual node as a service provider\n before you can delete the virtual node itself.

", "smithy.api#http": { - "method": "DELETE", "uri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2693,9 +2680,8 @@ "traits": { "smithy.api#documentation": "

Deletes an existing virtual router.

\n

You must delete any routes associated with the virtual router before you can delete the\n router itself.

", "smithy.api#http": { - "method": "DELETE", "uri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2781,9 +2767,8 @@ "traits": { "smithy.api#documentation": "

Deletes an existing virtual service.

", "smithy.api#http": { - "method": "DELETE", "uri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2866,9 +2851,8 @@ "traits": { "smithy.api#documentation": "

Describes an existing gateway route.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2953,9 +2937,8 @@ "traits": { "smithy.api#documentation": "

Describes an existing service mesh.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3030,9 +3013,8 @@ "traits": { "smithy.api#documentation": "

Describes an existing route.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3123,9 +3105,8 @@ "traits": { "smithy.api#documentation": "

Describes an existing virtual gateway.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3202,9 +3183,8 @@ "traits": { "smithy.api#documentation": "

Describes an existing virtual node.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3287,9 +3267,8 @@ "traits": { "smithy.api#documentation": "

Describes an existing virtual router.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3372,9 +3351,8 @@ "traits": { "smithy.api#documentation": "

Describes an existing virtual service.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3556,7 +3534,7 @@ "path": { "target": "com.amazonaws.appmesh#FilePath", "traits": { - "smithy.api#documentation": "

The file path to write access logs to. You can use /dev/stdout to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n awslogs, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.

\n \n \n

The Envoy process must have write permissions to the path that you specify here.\n Otherwise, Envoy fails to bootstrap properly.

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

The file path to write access logs to. You can use /dev/stdout to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n awslogs, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.

\n \n

The Envoy process must have write permissions to the path that you specify here.\n Otherwise, Envoy fails to bootstrap properly.

\n ", "smithy.api#required": {} } }, @@ -3623,10 +3601,7 @@ }, "traits": { "aws.api#arn": { - "template": "mesh/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoute/{gatewayRouteName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mesh/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoute/{gatewayRouteName}" } } }, @@ -3973,7 +3948,7 @@ "port": { "target": "com.amazonaws.appmesh#ListenerPort", "traits": { - "smithy.api#documentation": "

The port number to match from the request.

" + "smithy.api#documentation": "

The gateway route port to be matched on.

" } } }, @@ -4418,7 +4393,6 @@ "port": { "target": "com.amazonaws.appmesh#PortNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The destination port for the health check request. This port must match the port defined\n in the PortMapping for the listener.

" } }, @@ -4431,7 +4405,6 @@ "healthyThreshold": { "target": "com.amazonaws.appmesh#HealthCheckThreshold", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of consecutive successful health checks that must occur before declaring\n listener healthy.

", "smithy.api#required": {} } @@ -4439,7 +4412,6 @@ "unhealthyThreshold": { "target": "com.amazonaws.appmesh#HealthCheckThreshold", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy.

", "smithy.api#required": {} } @@ -4452,7 +4424,6 @@ "com.amazonaws.appmesh#HealthCheckThreshold": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 2, "max": 10 @@ -5141,15 +5112,14 @@ "traits": { "smithy.api#documentation": "

Returns a list of existing gateway routes that are associated to a virtual\n gateway.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "gatewayRoutes", - "pageSize": "limit" + "pageSize": "limit", + "items": "gatewayRoutes" }, "smithy.api#readonly": {} } @@ -5254,15 +5224,14 @@ "traits": { "smithy.api#documentation": "

Returns a list of existing service meshes.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "meshes", - "pageSize": "limit" + "pageSize": "limit", + "items": "meshes" }, "smithy.api#readonly": {} } @@ -5273,7 +5242,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListMeshes request where limit was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a previous paginated\n ListMeshes request where limit was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", "smithy.api#httpQuery": "nextToken" } }, @@ -5350,15 +5319,14 @@ "traits": { "smithy.api#documentation": "

Returns a list of existing routes in a service mesh.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "routes", - "pageSize": "limit" + "pageSize": "limit", + "items": "routes" }, "smithy.api#readonly": {} } @@ -5469,15 +5437,14 @@ "traits": { "smithy.api#documentation": "

List the tags for an App Mesh resource.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/tags", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "tags", - "pageSize": "limit" + "pageSize": "limit", + "items": "tags" }, "smithy.api#readonly": {}, "smithy.api#tags": [ @@ -5567,15 +5534,14 @@ "traits": { "smithy.api#documentation": "

Returns a list of existing virtual gateways in a service mesh.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualGateways", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "virtualGateways", - "pageSize": "limit" + "pageSize": "limit", + "items": "virtualGateways" }, "smithy.api#readonly": {} } @@ -5672,15 +5638,14 @@ "traits": { "smithy.api#documentation": "

Returns a list of existing virtual nodes.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualNodes", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "virtualNodes", - "pageSize": "limit" + "pageSize": "limit", + "items": "virtualNodes" }, "smithy.api#readonly": {} } @@ -5783,15 +5748,14 @@ "traits": { "smithy.api#documentation": "

Returns a list of existing virtual routers in a service mesh.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualRouters", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "virtualRouters", - "pageSize": "limit" + "pageSize": "limit", + "items": "virtualRouters" }, "smithy.api#readonly": {} } @@ -5894,15 +5858,14 @@ "traits": { "smithy.api#documentation": "

Returns a list of existing virtual services in a service mesh.

", "smithy.api#http": { - "method": "GET", "uri": "/v20190125/meshes/{meshName}/virtualServices", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "virtualServices", - "pageSize": "limit" + "pageSize": "limit", + "items": "virtualServices" }, "smithy.api#readonly": {} } @@ -6291,7 +6254,6 @@ "com.amazonaws.appmesh#MaxConnections": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -6300,7 +6262,6 @@ "com.amazonaws.appmesh#MaxPendingRequests": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -6309,7 +6270,6 @@ "com.amazonaws.appmesh#MaxRequests": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -6361,10 +6321,7 @@ ], "traits": { "aws.api#arn": { - "template": "mesh/{meshName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mesh/{meshName}" } } }, @@ -6627,7 +6584,6 @@ "port": { "target": "com.amazonaws.appmesh#PortNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The port used for the port mapping.

", "smithy.api#required": {} } @@ -6647,7 +6603,6 @@ "com.amazonaws.appmesh#PortNumber": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 65535 @@ -6812,10 +6767,7 @@ }, "traits": { "aws.api#arn": { - "template": "mesh/{meshName}/virtualRouter/{virtualRouterName}/route/{routeName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mesh/{meshName}/virtualRouter/{virtualRouterName}/route/{routeName}" } } }, @@ -7215,9 +7167,8 @@ "traits": { "smithy.api#documentation": "

Associates the specified tags to a resource with the specified resourceArn.\n If existing tags on a resource aren't specified in the request parameters, they aren't\n changed. When a resource is deleted, the tags associated with that resource are also\n deleted.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/tag", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7527,9 +7478,8 @@ "traits": { "smithy.api#documentation": "

Deletes specified tags from a resource.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/untag", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7604,9 +7554,8 @@ "traits": { "smithy.api#documentation": "

Updates an existing gateway route that is associated to a specified virtual gateway in a\n service mesh.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -7708,9 +7657,8 @@ "traits": { "smithy.api#documentation": "

Updates an existing service mesh.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -7796,9 +7744,8 @@ "traits": { "smithy.api#documentation": "

Updates an existing route for a specified service mesh and virtual router.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -7909,9 +7856,8 @@ "traits": { "smithy.api#documentation": "

Updates an existing virtual gateway in a specified service mesh.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -8008,9 +7954,8 @@ "traits": { "smithy.api#documentation": "

Updates an existing virtual node in a specified service mesh.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -8113,9 +8058,8 @@ "traits": { "smithy.api#documentation": "

Updates an existing virtual router in a specified service mesh.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -8218,9 +8162,8 @@ "traits": { "smithy.api#documentation": "

Updates an existing virtual service in a specified service mesh.

", "smithy.api#http": { - "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -8318,10 +8261,7 @@ ], "traits": { "aws.api#arn": { - "template": "mesh/{meshName}/virtualGateway/{virtualGatewayName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mesh/{meshName}/virtualGateway/{virtualGatewayName}" } } }, @@ -8533,7 +8473,6 @@ "maxRequests": { "target": "com.amazonaws.appmesh#MaxRequests", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of inflight requests Envoy can concurrently support across hosts in\n upstream cluster.

", "smithy.api#required": {} } @@ -8579,7 +8518,6 @@ "port": { "target": "com.amazonaws.appmesh#PortNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The destination port for the health check request. This port must match the port defined\n in the PortMapping for the listener.

" } }, @@ -8592,7 +8530,6 @@ "healthyThreshold": { "target": "com.amazonaws.appmesh#VirtualGatewayHealthCheckThreshold", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of consecutive successful health checks that must occur before declaring the\n listener healthy.

", "smithy.api#required": {} } @@ -8600,7 +8537,6 @@ "unhealthyThreshold": { "target": "com.amazonaws.appmesh#VirtualGatewayHealthCheckThreshold", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of consecutive failed health checks that must occur before declaring a\n virtual gateway unhealthy.

", "smithy.api#required": {} } @@ -8613,7 +8549,6 @@ "com.amazonaws.appmesh#VirtualGatewayHealthCheckThreshold": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 2, "max": 10 @@ -8635,7 +8570,6 @@ "maxRequests": { "target": "com.amazonaws.appmesh#MaxRequests", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of inflight requests Envoy can concurrently support across hosts in\n upstream cluster.

", "smithy.api#required": {} } @@ -8651,7 +8585,6 @@ "maxConnections": { "target": "com.amazonaws.appmesh#MaxConnections", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of outbound TCP connections Envoy can establish concurrently with all\n hosts in upstream cluster.

", "smithy.api#required": {} } @@ -8899,7 +8832,6 @@ "port": { "target": "com.amazonaws.appmesh#PortNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The port used for the port mapping. Specify one protocol.

", "smithy.api#required": {} } @@ -9179,10 +9111,7 @@ }, "traits": { "aws.api#arn": { - "template": "mesh/{meshName}/virtualNode/{virtualNodeName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mesh/{meshName}/virtualNode/{virtualNodeName}" } } }, @@ -9272,7 +9201,6 @@ "maxRequests": { "target": "com.amazonaws.appmesh#MaxRequests", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of inflight requests Envoy can concurrently support across hosts in\n upstream cluster.

", "smithy.api#required": {} } @@ -9288,7 +9216,6 @@ "maxRequests": { "target": "com.amazonaws.appmesh#MaxRequests", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of inflight requests Envoy can concurrently support across hosts in\n upstream cluster.

", "smithy.api#required": {} } @@ -9304,7 +9231,6 @@ "maxConnections": { "target": "com.amazonaws.appmesh#MaxConnections", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of outbound TCP connections Envoy can establish concurrently with all\n hosts in upstream cluster.

", "smithy.api#required": {} } @@ -9484,7 +9410,6 @@ "maxConnections": { "target": "com.amazonaws.appmesh#MaxConnections", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of outbound TCP connections Envoy can establish concurrently with all\n hosts in upstream cluster.

", "smithy.api#required": {} } @@ -9526,10 +9451,7 @@ ], "traits": { "aws.api#arn": { - "template": "mesh/{meshName}/virtualRouter/{virtualRouterName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mesh/{meshName}/virtualRouter/{virtualRouterName}" } } }, @@ -9761,10 +9683,7 @@ }, "traits": { "aws.api#arn": { - "template": "mesh/{meshName}/virtualService/{virtualServiceName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mesh/{meshName}/virtualService/{virtualServiceName}" } } }, diff --git a/codegen/sdk-codegen/aws-models/athena.json b/codegen/sdk-codegen/aws-models/athena.json index aa565d3d6a4..0dbe7cd13ba 100644 --- a/codegen/sdk-codegen/aws-models/athena.json +++ b/codegen/sdk-codegen/aws-models/athena.json @@ -282,7 +282,7 @@ "name": "athena" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Athena is an interactive query service that lets you use standard SQL\n to analyze data directly in Amazon S3. You can point Athena at your\n data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay\n only for the queries you run. Athena scales automatically—executing queries\n in parallel—so results are fast, even with large datasets and complex queries. For more\n information, see What is Amazon Athena in the Amazon Athena User\n Guide.

\n

If you connect to Athena using the JDBC driver, use version 1.1.0 of the\n driver or later with the Amazon Athena API. Earlier version drivers do not\n support the API. For more information and to download the driver, see Accessing\n Amazon Athena with JDBC.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Amazon Athena is an interactive query service that lets you use standard SQL\n to analyze data directly in Amazon S3. You can point Athena at your\n data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay\n only for the queries you run. Athena scales automatically—executing queries\n in parallel—so results are fast, even with large datasets and complex queries. For more\n information, see What is Amazon Athena in the Amazon Athena User\n Guide.

\n

If you connect to Athena using the JDBC driver, use version 1.1.0 of the\n driver or later with the Amazon Athena API. Earlier version drivers do not\n support the API. For more information and to download the driver, see Accessing\n Amazon Athena with JDBC.

", "smithy.api#title": "Amazon Athena", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1755,7 +1755,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

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

Cancels the capacity reservation with the specified name. Cancelled reservations\n remain in your account and will be deleted 45 days after cancellation. During the 45\n days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can\n refer to its tags and view it for historical reference.

", "smithy.api#idempotent": {} } }, @@ -1812,7 +1812,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

" + "smithy.api#documentation": "

Contains the submission time of a single allocation request for a capacity reservation\n and the most recent status of the attempted allocation.

" } }, "com.amazonaws.athena#CapacityAllocationStatus": { @@ -1869,7 +1869,7 @@ } }, "traits": { - "smithy.api#documentation": "

Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.

" + "smithy.api#documentation": "

Assigns Athena workgroups (and hence their queries) to capacity\n reservations. A capacity reservation can have only one capacity assignment\n configuration, but the capacity assignment configuration can be made up of multiple\n individual assignments. Each assignment specifies how Athena queries can\n consume capacity from the capacity reservation that their workgroup is mapped to.

" } }, "com.amazonaws.athena#CapacityAssignmentsList": { @@ -1927,7 +1927,7 @@ } }, "traits": { - "smithy.api#documentation": "

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

" + "smithy.api#documentation": "

A reservation for a specified number of data processing units (DPUs). When a\n reservation is initially created, it has no DPUs. Athena allocates DPUs\n until the allocated amount equals the requested amount.

" } }, "com.amazonaws.athena#CapacityReservationName": { @@ -2187,7 +2187,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a capacity reservation with the specified name and number of requested data processing units.

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

Creates a capacity reservation with the specified name and number of requested data\n processing units.

", "smithy.api#idempotent": {} } }, @@ -2272,7 +2272,7 @@ "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": { @@ -2310,7 +2310,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.

", "smithy.api#idempotent": {} } }, @@ -2603,7 +2603,7 @@ "Configuration": { "target": "com.amazonaws.athena#WorkGroupConfiguration", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "Description": { @@ -2636,13 +2636,13 @@ "KmsKey": { "target": "com.amazonaws.athena#KmsKey", "traits": { - "smithy.api#documentation": "

The KMS key that is used to encrypt the user's data stores in Athena.

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

The customer managed KMS key that is used to encrypt the user's data stores in Athena.

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

Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

" + "smithy.api#documentation": "

Specifies the customer managed KMS key that is used to encrypt the user's data stores\n in Athena. When an Amazon Web Services managed key is used, this value is\n null. This setting does not apply to Athena SQL workgroups.

" } }, "com.amazonaws.athena#DataCatalog": { @@ -2671,7 +2671,7 @@ "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 " } } }, @@ -2813,7 +2813,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.

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

Deletes a cancelled capacity reservation. A reservation must be cancelled before it\n can be deleted. A deleted reservation is immediately removed from your account and can\n no longer be referenced, including by its ARN. A deleted reservation cannot be called by\n GetCapacityReservation, and deleted reservations do not appear in the\n output of ListCapacityReservations.

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

Deletes the named query if you have access to the workgroup in which the query was\n saved.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Deletes the named query if you have access to the workgroup in which the query was\n saved.

", "smithy.api#idempotent": {} } }, @@ -3098,7 +3098,7 @@ } }, "traits": { - "smithy.api#documentation": "

If query and calculation results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE_KMS or CSE_KMS) and key\n information.

" + "smithy.api#documentation": "

If query and calculation results are encrypted in Amazon S3, indicates the\n encryption option used (for example, SSE_KMS or CSE_KMS) and\n key information.

" } }, "com.amazonaws.athena#EncryptionOption": { @@ -3130,7 +3130,7 @@ "CoordinatorDpuSize": { "target": "com.amazonaws.athena#CoordinatorDpuSize", "traits": { - "smithy.api#documentation": "

The number of DPUs to use for the coordinator. A coordinator is a special executor\n that orchestrates processing work and manages other executors in a notebook\n session. The default is 1.

" + "smithy.api#documentation": "

The number of DPUs to use for the coordinator. A coordinator is a special executor\n that orchestrates processing work and manages other executors in a notebook session. The\n default is 1.

" } }, "MaxConcurrentDpus": { @@ -3143,7 +3143,7 @@ "DefaultExecutorDpuSize": { "target": "com.amazonaws.athena#DefaultExecutorDpuSize", "traits": { - "smithy.api#documentation": "

The default number of DPUs to use for executors. An executor is the smallest unit of\n compute that a notebook session can request from Athena. The default is 1.

" + "smithy.api#documentation": "

The default number of DPUs to use for executors. An executor is the smallest unit of\n compute that a notebook session can request from Athena. The default is\n 1.

" } }, "AdditionalConfigs": { @@ -3155,7 +3155,7 @@ "SparkProperties": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

" + "smithy.api#documentation": "

Specifies custom jar files and Spark properties for use cases like cluster encryption,\n table formats, and general Spark tuning.

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

Gets the capacity assignment configuration for a capacity reservation, if one exists.

" + "smithy.api#documentation": "

Gets the capacity assignment configuration for a capacity reservation, if one\n exists.

" } }, "com.amazonaws.athena#GetCapacityAssignmentConfigurationInput": { @@ -3676,7 +3676,7 @@ "CapacityReservationName": { "target": "com.amazonaws.athena#CapacityReservationName", "traits": { - "smithy.api#documentation": "

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

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

The name of the capacity reservation to retrieve the capacity assignment configuration\n for.

", "smithy.api#required": {} } } @@ -3691,7 +3691,7 @@ "CapacityAssignmentConfiguration": { "target": "com.amazonaws.athena#CapacityAssignmentConfiguration", "traits": { - "smithy.api#documentation": "

The requested capacity assignment configuration for the specified capacity reservation.

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

The requested capacity assignment configuration for the specified capacity\n reservation.

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

Provides a list of available query IDs only for queries saved in the specified\n workgroup. Requires that you have access to the specified workgroup. If a workgroup is\n not specified, lists the saved queries for the primary workgroup.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Provides a list of available query IDs only for queries saved in the specified\n workgroup. Requires that you have access to the specified workgroup. If a workgroup is\n not specified, lists the saved queries for the primary workgroup.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5428,7 +5428,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of available query execution IDs for the queries in the specified\n workgroup. If a workgroup is not specified, returns a list of query execution IDs for\n the primary workgroup. Requires you to have access to the workgroup in which the queries\n ran.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Provides a list of available query execution IDs for the queries in the specified\n workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for\n the primary workgroup. Requires you to have access to the workgroup in which the queries\n ran.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6293,7 +6293,7 @@ } ], "traits": { - "smithy.api#documentation": "

Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

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

Puts a new capacity assignment configuration for a specified capacity reservation. If\n a capacity assignment configuration already exists for the capacity reservation,\n replaces the existing capacity assignment configuration.

", "smithy.api#idempotent": {} } }, @@ -6303,7 +6303,7 @@ "CapacityReservationName": { "target": "com.amazonaws.athena#CapacityReservationName", "traits": { - "smithy.api#documentation": "

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

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

The name of the capacity reservation to put a capacity assignment configuration\n for.

", "smithy.api#required": {} } }, @@ -6350,7 +6350,7 @@ "ResultConfiguration": { "target": "com.amazonaws.athena#ResultConfiguration", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where query and calculation results are stored and the encryption\n option, if any, used for query results. These are known as \"client-side settings\". If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the\n workgroup.

" + "smithy.api#documentation": "

The location in Amazon S3 where query and calculation results are stored and\n the encryption option, if any, used for query results. These are known as \"client-side\n settings\". If workgroup settings override client-side settings, then the query uses the\n location for the query results and the encryption configuration that are specified for\n the workgroup.

" } }, "ResultReuseConfiguration": { @@ -6392,7 +6392,7 @@ "ExecutionParameters": { "target": "com.amazonaws.athena#ExecutionParameters", "traits": { - "smithy.api#documentation": "

A list of values for the parameters in a query. The values are applied sequentially to\n the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

" + "smithy.api#documentation": "

A list of values for the parameters in a query. The values are applied sequentially to\n the parameters in the query in the order in which the parameters occur. The list of\n parameters is not returned in the response.

" } }, "SubstatementType": { @@ -6522,6 +6522,12 @@ "smithy.api#documentation": "

The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically\n add the query back to the queue.

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

The number of milliseconds that Athena took to preprocess the query before submitting the query to the query engine.

" + } + }, "QueryPlanningTimeInMillis": { "target": "com.amazonaws.athena#Long", "traits": { @@ -6644,6 +6650,12 @@ "smithy.api#documentation": "

The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically\n add the query back to the queue.

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

\n The number of milliseconds that Athena spends on preprocessing before it submits the query to the engine.\n

" + } + }, "QueryPlanningTimeInMillis": { "target": "com.amazonaws.athena#Long", "traits": { @@ -6812,13 +6824,13 @@ "OutputLocation": { "target": "com.amazonaws.athena#ResultOutputLocation", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored, such as\n s3://path/to/query/bucket/. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Working with query\n results, recent queries, and output files. If workgroup settings override\n client-side settings, then the query uses the settings specified for the workgroup. See\n WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored,\n such as s3://path/to/query/bucket/. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Working with query\n results, recent queries, and output files. If workgroup settings override\n client-side settings, then the query uses the settings specified for the workgroup. See\n WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

If query and calculation results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE_KMS or CSE_KMS) and key information.\n This is a client-side setting. If workgroup settings override client-side settings, then\n the query uses the encryption configuration that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + "smithy.api#documentation": "

If query and calculation results are encrypted in Amazon S3, indicates the\n encryption option used (for example, SSE_KMS or CSE_KMS) and\n key information. This is a client-side setting. If workgroup settings override\n client-side settings, then the query uses the encryption configuration that is specified\n for the workgroup, and also uses the location for storing query results specified in the\n workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration\n and Workgroup Settings Override Client-Side Settings.

" } }, "ExpectedBucketOwner": { @@ -6835,7 +6847,7 @@ } }, "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where query and calculation results are stored and the encryption\n option, if any, used for query and calculation results. These are known as \"client-side settings\". If\n workgroup settings override client-side settings, then the query uses the workgroup\n settings.

" + "smithy.api#documentation": "

The location in Amazon S3 where query and calculation results are stored and\n the encryption option, if any, used for query and calculation results. These are known\n as \"client-side settings\". If workgroup settings override client-side settings, then the\n query uses the workgroup settings.

" } }, "com.amazonaws.athena#ResultConfigurationUpdates": { @@ -6844,7 +6856,7 @@ "OutputLocation": { "target": "com.amazonaws.athena#ResultOutputLocation", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored, such as\n s3://path/to/query/bucket/. For more information, see Working with query\n results, recent queries, and output files. If workgroup settings override\n client-side settings, then the query uses the location for the query results and the\n encryption configuration that are specified for the workgroup. The \"workgroup settings\n override\" is specified in EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored,\n such as s3://path/to/query/bucket/. For more information, see Working with query\n results, recent queries, and output files. If workgroup settings override\n client-side settings, then the query uses the location for the query results and the\n encryption configuration that are specified for the workgroup. The \"workgroup settings\n override\" is specified in EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "RemoveOutputLocation": { @@ -7052,7 +7064,7 @@ "ExecutionRole": { "target": "com.amazonaws.athena#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the execution role used for the session.

" + "smithy.api#documentation": "

The ARN of the execution role used in a Spark session to access user resources. This\n property applies only to Spark-enabled workgroups.

" } }, "WorkingDirectory": { @@ -7283,7 +7295,7 @@ } ], "traits": { - "smithy.api#documentation": "

Submits calculations for execution within a session. You can supply the code to run as\n an inline code block within the request.

" + "smithy.api#documentation": "

Submits calculations for execution within a session. You can supply the code to run as\n an inline code block within the request.

\n \n

The request syntax requires the\n StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock\n parameter, but not both. Because \n CalculationConfiguration$CodeBlock is deprecated, use the\n StartCalculationExecutionRequest$CodeBlock parameter instead.

\n " } }, "com.amazonaws.athena#StartCalculationExecutionRequest": { @@ -7314,7 +7326,7 @@ "CodeBlock": { "target": "com.amazonaws.athena#CodeBlock", "traits": { - "smithy.api#documentation": "

A string that contains the code of the calculation.

" + "smithy.api#documentation": "

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

" } }, "ClientRequestToken": { @@ -7493,7 +7505,7 @@ "NotebookVersion": { "target": "com.amazonaws.athena#NameString", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "SessionIdleTimeoutInMinutes": { @@ -7635,7 +7647,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.

", "smithy.api#idempotent": {} } }, @@ -7760,7 +7772,7 @@ } }, "traits": { - "smithy.api#documentation": "

A label that you assign to a resource. Athena resources include \n workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of\n which you define. For example, you can use tags to categorize Athena\n resources by purpose, owner, or environment. Use a consistent set of\n tag keys to make it easier to search and filter the resources in your\n account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas.

" + "smithy.api#documentation": "

A label that you assign to a resource. Athena resources include\n workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an\n optional value, both of which you define. For example, you can use tags to categorize\n Athena resources by purpose, owner, or environment. Use a consistent set\n of tag keys to make it easier to search and filter the resources in your account. For\n best practices, see Tagging\n Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and\n tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and\n numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys\n and values are case-sensitive. Tag keys must be unique per resource. If you specify more\n than one tag, separate them by commas.

" } }, "com.amazonaws.athena#TagKey": { @@ -7804,7 +7816,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to an Athena resource. A tag is a label that you\n assign to a resource. Each tag consists of a key and an optional value, both of which you define. For\n example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to\n search and filter the resources in your account. For best practices, see\n Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas.

" + "smithy.api#documentation": "

Adds one or more tags to an Athena resource. A tag is a label that you\n assign to a resource. Each tag consists of a key and an optional value, both of which\n you define. For example, you can use tags to categorize Athena workgroups,\n data catalogs, or capacity reservations by purpose, owner, or environment. Use a\n consistent set of tag keys to make it easier to search and filter the resources in your\n account. For best practices, see Tagging\n Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and\n tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and\n numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys\n and values are case-sensitive. Tag keys must be unique per resource. If you specify more\n than one tag, separate them by commas.

" } }, "com.amazonaws.athena#TagResourceInput": { @@ -7813,7 +7825,7 @@ "ResourceARN": { "target": "com.amazonaws.athena#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Athena resource to\n which tags are to be added.

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

Specifies the ARN of the Athena resource to which tags are to be\n added.

", "smithy.api#required": {} } }, @@ -8121,7 +8133,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the number of requested data processing units for the capacity reservation with the specified name.

" + "smithy.api#documentation": "

Updates the number of requested data processing units for the capacity reservation\n with the specified name.

" } }, "com.amazonaws.athena#UpdateCapacityReservationInput": { @@ -8550,7 +8562,7 @@ "Configuration": { "target": "com.amazonaws.athena#WorkGroupConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup;\n whether workgroup settings override client-side settings; and the data usage limits for\n the amount of data scanned per query or per workgroup. The workgroup settings override\n is specified in EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The configuration of the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored, the encryption configuration, if any,\n used for query and calculation results; whether the Amazon CloudWatch Metrics are\n enabled for the workgroup; whether workgroup settings override client-side settings; and\n the data usage limits for the amount of data scanned per query or per workgroup. The\n workgroup settings override is specified in EnforceWorkGroupConfiguration\n (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "Description": { @@ -8576,7 +8588,7 @@ "ResultConfiguration": { "target": "com.amazonaws.athena#ResultConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the\n ways: either in the workgroup using this setting, or for individual queries\n (client-side), using ResultConfiguration$OutputLocation. If none of\n them is set, Athena issues an error that no output location is provided. For\n more information, see Working with query results, recent queries, and output files.

" + "smithy.api#documentation": "

The configuration for the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored and the encryption option, if any, used\n for query and calculation results. To run the query, you must specify the query results\n location using one of the ways: either in the workgroup using this setting, or for\n individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more\n information, see Working with query results, recent queries, and output files.

" } }, "EnforceWorkGroupConfiguration": { @@ -8618,7 +8630,7 @@ "ExecutionRole": { "target": "com.amazonaws.athena#RoleArn", "traits": { - "smithy.api#documentation": "

Role used in a session for accessing the user's resources.

" + "smithy.api#documentation": "

Role used in a Spark session for accessing the user's resources. This property applies\n only to Spark-enabled workgroups.

" } }, "CustomerContentEncryptionConfiguration": { @@ -8630,12 +8642,12 @@ "EnableMinimumEncryptionConfiguration": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Enforces a minimal level of encryption for the workgroup for query and calculation\n results that are written to Amazon S3. When enabled, workgroup users can set\n encryption only to the minimum level set by the administrator or higher when they submit queries.

\n

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

" + "smithy.api#documentation": "

Enforces a minimal level of encryption for the workgroup for query and calculation\n results that are written to Amazon S3. When enabled, workgroup users can set\n encryption only to the minimum level set by the administrator or higher when they submit\n queries.

\n

The EnforceWorkGroupConfiguration setting takes precedence over the\n EnableMinimumEncryptionConfiguration flag. This means that if\n EnforceWorkGroupConfiguration is true, the\n EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup\n configuration for encryption is used.

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

The configuration of the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored, the encryption option, if any, used for query and calculation results,\n whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether\n workgroup settings override query settings, and the data usage limits for the amount of\n data scanned per query or per workgroup. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The configuration of the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored, the encryption option, if any, used for\n query and calculation results, whether the Amazon CloudWatch Metrics are enabled for\n the workgroup and whether workgroup settings override query settings, and the data usage\n limits for the amount of data scanned per query or per workgroup. The workgroup settings\n override is specified in EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "com.amazonaws.athena#WorkGroupConfigurationUpdates": { @@ -8698,7 +8710,7 @@ "ExecutionRole": { "target": "com.amazonaws.athena#RoleArn", "traits": { - "smithy.api#documentation": "

Contains the ARN of the execution role for the workgroup

" + "smithy.api#documentation": "

The ARN of the execution role used to access user resources. This property applies\n only to Spark-enabled workgroups.

" } }, "CustomerContentEncryptionConfiguration": { @@ -8707,12 +8719,12 @@ "EnableMinimumEncryptionConfiguration": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Enforces a minimal level of encryption for the workgroup for query and calculation\n results that are written to Amazon S3. When enabled, workgroup users can set\n encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

\n

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

" + "smithy.api#documentation": "

Enforces a minimal level of encryption for the workgroup for query and calculation\n results that are written to Amazon S3. When enabled, workgroup users can set\n encryption only to the minimum level set by the administrator or higher when they submit\n queries. This setting does not apply to Spark-enabled workgroups.

\n

The EnforceWorkGroupConfiguration setting takes precedence over the\n EnableMinimumEncryptionConfiguration flag. This means that if\n EnforceWorkGroupConfiguration is true, the\n EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup\n configuration for encryption is used.

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

The configuration information that will be updated for this workgroup, which includes\n the location in Amazon S3 where query and calculation results are stored, the encryption option,\n if any, used for query results, whether the Amazon CloudWatch Metrics are enabled\n for the workgroup, whether the workgroup settings override the client-side settings, and\n the data usage limit for the amount of bytes scanned per query, if it is\n specified.

" + "smithy.api#documentation": "

The configuration information that will be updated for this workgroup, which includes\n the location in Amazon S3 where query and calculation results are stored, the\n encryption option, if any, used for query results, whether the Amazon CloudWatch\n Metrics are enabled for the workgroup, whether the workgroup settings override the\n client-side settings, and the data usage limit for the amount of bytes scanned per\n query, if it is specified.

" } }, "com.amazonaws.athena#WorkGroupDescriptionString": { diff --git a/codegen/sdk-codegen/aws-models/cloud9.json b/codegen/sdk-codegen/aws-models/cloud9.json index 1d232aa4d74..6b571be3c82 100644 --- a/codegen/sdk-codegen/aws-models/cloud9.json +++ b/codegen/sdk-codegen/aws-models/cloud9.json @@ -1125,6 +1125,7 @@ "name": "my-demo-environment", "description": "This is my demonstration environment.", "instanceType": "t2.micro", + "imageId": "amazonlinux-2-x86_64", "subnetId": "subnet-6300cd1b", "automaticStopTimeMinutes": 60, "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser" @@ -1175,7 +1176,7 @@ "imageId": { "target": "com.amazonaws.cloud9#ImageId", "traits": { - "smithy.api#documentation": "

The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\n To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)\n path.

\n

From November 20, 2023, you will be required to include the imageId parameter for the CreateEnvironmentEC2 action.\n This change will be reflected across all direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only \n affect direct API consumers, and not Cloud9 console users.

\n

From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of \n maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the AMI to create your environment as it is \n fully supported. This change will only affect direct API consumers, and not Cloud9 console users.

\n

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

\n

\n AMI aliases \n

\n \n

\n SSM paths\n

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

The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\n To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)\n path.

\n

From December 04, 2023, you will be required to include the imageId parameter\n for the CreateEnvironmentEC2 action. This change will be reflected across all\n direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services\n CloudFormation. This change will only affect direct API consumers, and not Cloud9 console\n users.

\n

From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image\n IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December\n 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux\n 2 as the AMI to create your environment as it is fully supported. This change will only affect\n direct API consumers, and not Cloud9 console users.

\n

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

\n

\n AMI aliases \n

\n \n

\n SSM paths\n

\n " } }, "automaticStopTimeMinutes": { diff --git a/codegen/sdk-codegen/aws-models/cloudformation.json b/codegen/sdk-codegen/aws-models/cloudformation.json index 2ebbce7c93e..78f14830fdf 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.json @@ -956,6 +956,12 @@ "traits": { "smithy.api#documentation": "

The root change set ID.

" } + }, + "ImportExistingResources": { + "target": "com.amazonaws.cloudformation#ImportExistingResources", + "traits": { + "smithy.api#documentation": "

Indicates if the stack set imports resources that already exist.

" + } } }, "traits": { @@ -2301,17 +2307,6 @@ "expect": { "error": "Invalid Configuration: Missing Region" } - }, - { - "documentation": "Partition doesn't support DualStack", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } } ], "version": "1.0" @@ -2482,7 +2477,7 @@ "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Controlling access\n with Identity and Access Management in the CloudFormation User Guide.

\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

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

The template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Controlling access\n with Identity and Access Management in the CloudFormation User Guide.

\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

\n " } }, "RoleARN": { @@ -2552,6 +2547,12 @@ "traits": { "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:

\n \n

For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.

" } + }, + "ImportExistingResources": { + "target": "com.amazonaws.cloudformation#ImportExistingResources", + "traits": { + "smithy.api#documentation": "

Indicates if the stack set imports resources that already exist.

\n \n

This parameter can only import resources that have custom names in templates. For more information, see name type in the\n CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,\n use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation\n management in the CloudFormation User Guide.

\n " + } } }, "traits": { @@ -2620,13 +2621,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template anatomy in the CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template anatomy in the CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" } }, "Parameters": { @@ -3527,7 +3528,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the\n change set. For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.

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

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the\n change set. For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -3819,6 +3820,12 @@ "traits": { "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:

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

Indicates if the stack set imports resources that already exist.

\n \n

This parameter can only import resources that have custom names in templates. To import\n resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

\n " + } } }, "traits": { @@ -4033,7 +4040,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackEventsOutput" }, "traits": { - "smithy.api#documentation": "

Returns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, go to Stacks in the CloudFormation User Guide.

\n \n

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).

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

Returns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, go to Stacks in the\n CloudFormation User Guide.

\n \n

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5457,13 +5464,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" } }, "Parameters": { @@ -5737,7 +5744,7 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)

" + "smithy.api#documentation": "

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)

" } } }, @@ -5796,7 +5803,7 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

CloudFormation returns the same template that was used when the stack was created.

" + "smithy.api#documentation": "

Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

CloudFormation returns the same template that was used when the stack was created.

" } }, "StagesAvailable": { @@ -5834,13 +5841,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" } }, "StackName": { @@ -6218,6 +6225,9 @@ } } }, + "com.amazonaws.cloudformation#ImportExistingResources": { + "type": "boolean" + }, "com.amazonaws.cloudformation#ImportStacksToStackSet": { "type": "operation", "input": { @@ -9408,7 +9418,7 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" + "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

" } }, "StackPolicyURL": { @@ -10264,7 +10274,7 @@ "PhysicalResourceIdContext": { "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { - "smithy.api#documentation": "

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context\n key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely\n identify that resource. Each context key-value pair specifies a unique resource that contains the\n targeted resource.

" + "smithy.api#documentation": "

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough\n to uniquely identify that resource. Each context key-value pair specifies a unique resource\n that contains the targeted resource.

" } }, "ResourceType": { @@ -10278,7 +10288,7 @@ "PropertyDifferences": { "target": "com.amazonaws.cloudformation#PropertyDifferences", "traits": { - "smithy.api#documentation": "

Status of the actual configuration of the resource compared to its expected configuration.\n These will be present only for resources whose StackInstanceResourceDriftStatus is\n MODIFIED.

" + "smithy.api#documentation": "

Status of the actual configuration of the resource compared to its expected\n configuration. These will be present only for resources whose\n StackInstanceResourceDriftStatus is MODIFIED.

" } }, "StackResourceDriftStatus": { @@ -11327,7 +11337,7 @@ "ConcurrencyMode": { "target": "com.amazonaws.cloudformation#ConcurrencyMode", "traits": { - "smithy.api#documentation": "

Specifies how the concurrency level behaves during the operation execution.

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

Specifies how the concurrency level behaves during the operation execution.

\n " } } }, @@ -12762,13 +12772,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.

" } }, "UsePreviousTemplate": { @@ -13237,13 +13247,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/codepipeline.json b/codegen/sdk-codegen/aws-models/codepipeline.json index ab068a2b2b4..d531132cc4d 100644 --- a/codegen/sdk-codegen/aws-models/codepipeline.json +++ b/codegen/sdk-codegen/aws-models/codepipeline.json @@ -4036,7 +4036,7 @@ } }, "traits": { - "smithy.api#documentation": "

A type of trigger configuration for Git-based source actions.

\n \n

You can specify the Git configuration trigger type for all third-party\n Git-based source actions that are supported by the\n CodeStarSourceConnection action type.

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

A type of trigger configuration for Git-based source actions.

\n \n

You can specify the Git configuration trigger type for all third-party\n Git-based source actions that are supported by the\n CodeStarSourceConnection action type.

\n \n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

\n " } }, "com.amazonaws.codepipeline#GitPushFilter": { @@ -5374,7 +5374,7 @@ "pipelineType": { "target": "com.amazonaws.codepipeline#PipelineType", "traits": { - "smithy.api#documentation": "

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n \n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

" + "smithy.api#documentation": "

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n \n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

\n " } }, "triggers": { @@ -5688,7 +5688,7 @@ "pipelineType": { "target": "com.amazonaws.codepipeline#PipelineType", "traits": { - "smithy.api#documentation": "

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n \n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

" + "smithy.api#documentation": "

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n \n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

\n " } }, "created": { @@ -5727,7 +5727,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents information about the specified trigger configuration, such as the\n filter criteria and the source stage for the action that contains the trigger.

\n \n

This is only supported for the CodeStarSourceConnection action\n type.

\n \n \n

When a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.

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

Represents information about the specified trigger configuration, such as the\n filter criteria and the source stage for the action that contains the trigger.

\n \n

This is only supported for the CodeStarSourceConnection action\n type.

\n \n \n

When a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.

\n \n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

\n " } }, "com.amazonaws.codepipeline#PipelineTriggerDeclarationList": { @@ -5789,7 +5789,7 @@ } }, "traits": { - "smithy.api#documentation": "

A pipeline-level variable used for a pipeline execution.

" + "smithy.api#documentation": "

A pipeline-level variable used for a pipeline execution.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

\n " } }, "com.amazonaws.codepipeline#PipelineVariableDeclaration": { @@ -5816,7 +5816,7 @@ } }, "traits": { - "smithy.api#documentation": "

A variable declared at the pipeline level.

" + "smithy.api#documentation": "

A variable declared at the pipeline level.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

\n " } }, "com.amazonaws.codepipeline#PipelineVariableDeclarationList": { @@ -6913,6 +6913,70 @@ "target": "com.amazonaws.codepipeline#SourceRevision" } }, + "com.amazonaws.codepipeline#SourceRevisionOverride": { + "type": "structure", + "members": { + "actionName": { + "target": "com.amazonaws.codepipeline#ActionName", + "traits": { + "smithy.api#documentation": "

The name of the action where the override will be applied.

", + "smithy.api#required": {} + } + }, + "revisionType": { + "target": "com.amazonaws.codepipeline#SourceRevisionType", + "traits": { + "smithy.api#documentation": "

The type of source revision, based on the source provider. For example, the revision\n type for the CodeCommit action provider is the commit ID.

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

The source revision, or version of your source artifact, with the changes that you\n want to run in the pipeline execution.

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

A list that allows you to specify, or override, the source revision for a pipeline\n execution that's being started. A source revision is the version with all the changes to\n your application code, or source artifact, for the pipeline execution.

" + } + }, + "com.amazonaws.codepipeline#SourceRevisionOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#SourceRevisionOverride" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.codepipeline#SourceRevisionType": { + "type": "enum", + "members": { + "COMMIT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMIT_ID" + } + }, + "IMAGE_DIGEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_DIGEST" + } + }, + "S3_OBJECT_VERSION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_OBJECT_VERSION_ID" + } + } + } + }, "com.amazonaws.codepipeline#StageActionDeclarationList": { "type": "list", "member": { @@ -7190,6 +7254,12 @@ "smithy.api#documentation": "

The system-generated unique ID used to identify a unique execution\n request.

", "smithy.api#idempotencyToken": {} } + }, + "sourceRevisions": { + "target": "com.amazonaws.codepipeline#SourceRevisionOverrideList", + "traits": { + "smithy.api#documentation": "

A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/codestar-connections.json b/codegen/sdk-codegen/aws-models/codestar-connections.json index bb29e1959bd..f3c2002f478 100644 --- a/codegen/sdk-codegen/aws-models/codestar-connections.json +++ b/codegen/sdk-codegen/aws-models/codestar-connections.json @@ -29,6 +29,19 @@ ] }, "shapes": { + "com.amazonaws.codestarconnections#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.codestarconnections#AccountId": { "type": "string", "traits": { @@ -49,6 +62,44 @@ "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" } }, + "com.amazonaws.codestarconnections#BlockerStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVED" + } + } + } + }, + "com.amazonaws.codestarconnections#BlockerType": { + "type": "enum", + "members": { + "AUTOMATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATED" + } + } + } + }, + "com.amazonaws.codestarconnections#BranchName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, "com.amazonaws.codestarconnections#CodeStar_connections_20191201": { "type": "service", "version": "2019-12-01", @@ -59,24 +110,60 @@ { "target": "com.amazonaws.codestarconnections#CreateHost" }, + { + "target": "com.amazonaws.codestarconnections#CreateRepositoryLink" + }, + { + "target": "com.amazonaws.codestarconnections#CreateSyncConfiguration" + }, { "target": "com.amazonaws.codestarconnections#DeleteConnection" }, { "target": "com.amazonaws.codestarconnections#DeleteHost" }, + { + "target": "com.amazonaws.codestarconnections#DeleteRepositoryLink" + }, + { + "target": "com.amazonaws.codestarconnections#DeleteSyncConfiguration" + }, { "target": "com.amazonaws.codestarconnections#GetConnection" }, { "target": "com.amazonaws.codestarconnections#GetHost" }, + { + "target": "com.amazonaws.codestarconnections#GetRepositoryLink" + }, + { + "target": "com.amazonaws.codestarconnections#GetRepositorySyncStatus" + }, + { + "target": "com.amazonaws.codestarconnections#GetResourceSyncStatus" + }, + { + "target": "com.amazonaws.codestarconnections#GetSyncBlockerSummary" + }, + { + "target": "com.amazonaws.codestarconnections#GetSyncConfiguration" + }, { "target": "com.amazonaws.codestarconnections#ListConnections" }, { "target": "com.amazonaws.codestarconnections#ListHosts" }, + { + "target": "com.amazonaws.codestarconnections#ListRepositoryLinks" + }, + { + "target": "com.amazonaws.codestarconnections#ListRepositorySyncDefinitions" + }, + { + "target": "com.amazonaws.codestarconnections#ListSyncConfigurations" + }, { "target": "com.amazonaws.codestarconnections#ListTagsForResource" }, @@ -88,6 +175,15 @@ }, { "target": "com.amazonaws.codestarconnections#UpdateHost" + }, + { + "target": "com.amazonaws.codestarconnections#UpdateRepositoryLink" + }, + { + "target": "com.amazonaws.codestarconnections#UpdateSyncBlocker" + }, + { + "target": "com.amazonaws.codestarconnections#UpdateSyncConfiguration" } ], "traits": { @@ -146,7 +242,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -189,7 +284,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -202,7 +298,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -216,7 +311,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -239,7 +333,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -274,7 +367,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -285,14 +377,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -306,14 +400,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -322,11 +414,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -337,14 +429,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -358,7 +452,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -378,7 +471,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -389,14 +481,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -407,9 +501,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -929,6 +1025,32 @@ } } }, + "com.amazonaws.codestarconnections#ConcurrentModificationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.codestarconnections#ConditionalCheckFailedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The conditional check failed. Try again later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.codestarconnections#ConflictException": { "type": "structure", "members": { @@ -1160,7 +1282,10 @@ } }, "Tags": { - "target": "com.amazonaws.codestarconnections#TagList" + "target": "com.amazonaws.codestarconnections#TagList", + "traits": { + "smithy.api#documentation": "

Tags for the host to be created.

" + } } }, "traits": { @@ -1177,79 +1302,184 @@ } }, "Tags": { - "target": "com.amazonaws.codestarconnections#TagList" + "target": "com.amazonaws.codestarconnections#TagList", + "traits": { + "smithy.api#documentation": "

Tags for the created host.

" + } } }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#DeleteConnection": { + "com.amazonaws.codestarconnections#CreateRepositoryLink": { "type": "operation", "input": { - "target": "com.amazonaws.codestarconnections#DeleteConnectionInput" + "target": "com.amazonaws.codestarconnections#CreateRepositoryLinkInput" }, "output": { - "target": "com.amazonaws.codestarconnections#DeleteConnectionOutput" + "target": "com.amazonaws.codestarconnections#CreateRepositoryLinkOutput" }, "errors": [ { - "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#LimitExceededException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

The connection to be deleted.

" + "smithy.api#documentation": "

Creates a link to a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

" } }, - "com.amazonaws.codestarconnections#DeleteConnectionInput": { + "com.amazonaws.codestarconnections#CreateRepositoryLinkInput": { "type": "structure", "members": { "ConnectionArn": { "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection to be deleted.

\n \n

The ARN is never reused if the connection is deleted.

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

The Amazon Resource Name (ARN) of the connection to be associated with the repository link.

", + "smithy.api#required": {} + } + }, + "OwnerId": { + "target": "com.amazonaws.codestarconnections#OwnerId", + "traits": { + "smithy.api#documentation": "

The owner ID for the repository associated with a specific sync configuration, such as\n the owner ID in GitHub.

", + "smithy.api#required": {} + } + }, + "RepositoryName": { + "target": "com.amazonaws.codestarconnections#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to be associated with the repository link.

", "smithy.api#required": {} } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.codestarconnections#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) encryption key for the repository to be associated with the repository link.

" + } + }, + "Tags": { + "target": "com.amazonaws.codestarconnections#TagList", + "traits": { + "smithy.api#documentation": "

The tags for the repository to be associated with the repository link.

" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#DeleteConnectionOutput": { + "com.amazonaws.codestarconnections#CreateRepositoryLinkOutput": { "type": "structure", - "members": {}, + "members": { + "RepositoryLinkInfo": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkInfo", + "traits": { + "smithy.api#documentation": "

The returned information about the created repository link.

", + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#DeleteHost": { + "com.amazonaws.codestarconnections#CreateSyncConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.codestarconnections#DeleteHostInput" + "target": "com.amazonaws.codestarconnections#CreateSyncConfigurationInput" }, "output": { - "target": "com.amazonaws.codestarconnections#DeleteHostOutput" + "target": "com.amazonaws.codestarconnections#CreateSyncConfigurationOutput" }, "errors": [ { - "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + "target": "com.amazonaws.codestarconnections#AccessDeniedException" }, { - "target": "com.amazonaws.codestarconnections#ResourceUnavailableException" + "target": "com.amazonaws.codestarconnections#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#LimitExceededException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

\n \n

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

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

Creates a sync configuration which allows Amazon Web Services to sync content from a Git\n repository to update a specified Amazon Web Services resource. Parameters for the sync\n configuration are determined by the sync type.

" } }, - "com.amazonaws.codestarconnections#DeleteHostInput": { + "com.amazonaws.codestarconnections#CreateSyncConfigurationInput": { "type": "structure", "members": { - "HostArn": { - "target": "com.amazonaws.codestarconnections#HostArn", + "Branch": { + "target": "com.amazonaws.codestarconnections#BranchName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host to be deleted.

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

The branch in the repository from which changes will be synced.

", + "smithy.api#required": {} + } + }, + "ConfigFile": { + "target": "com.amazonaws.codestarconnections#DeploymentFilePath", + "traits": { + "smithy.api#documentation": "

The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

", + "smithy.api#required": {} + } + }, + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The ID of the repository link created for the connection. A repository link allows Git\n sync to monitor and sync changes to files in a specified Git repository.

", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services resource (for example, a CloudFormation stack in the\n case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.codestarconnections#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to\n update a given Amazon Web Services resource on your behalf.

", + "smithy.api#required": {} + } + }, + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The type of sync configuration.

", "smithy.api#required": {} } } @@ -1258,49 +1488,48 @@ "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#DeleteHostOutput": { + "com.amazonaws.codestarconnections#CreateSyncConfigurationOutput": { "type": "structure", - "members": {}, + "members": { + "SyncConfiguration": { + "target": "com.amazonaws.codestarconnections#SyncConfiguration", + "traits": { + "smithy.api#documentation": "

The created sync configuration for the connection. A sync configuration allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services\n resource.

", + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 600 - } - } + "com.amazonaws.codestarconnections#CreatedReason": { + "type": "string" }, - "com.amazonaws.codestarconnections#GetConnection": { + "com.amazonaws.codestarconnections#DeleteConnection": { "type": "operation", "input": { - "target": "com.amazonaws.codestarconnections#GetConnectionInput" + "target": "com.amazonaws.codestarconnections#DeleteConnectionInput" }, "output": { - "target": "com.amazonaws.codestarconnections#GetConnectionOutput" + "target": "com.amazonaws.codestarconnections#DeleteConnectionOutput" }, "errors": [ { "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.codestarconnections#ResourceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns the connection ARN and details such as status, owner, and provider type.

" + "smithy.api#documentation": "

The connection to be deleted.

" } }, - "com.amazonaws.codestarconnections#GetConnectionInput": { + "com.amazonaws.codestarconnections#DeleteConnectionInput": { "type": "structure", "members": { "ConnectionArn": { "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a connection.

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

The Amazon Resource Name (ARN) of the connection to be deleted.

\n \n

The ARN is never reused if the connection is deleted.

\n ", "smithy.api#required": {} } } @@ -1309,27 +1538,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#GetConnectionOutput": { + "com.amazonaws.codestarconnections#DeleteConnectionOutput": { "type": "structure", - "members": { - "Connection": { - "target": "com.amazonaws.codestarconnections#Connection", - "traits": { - "smithy.api#documentation": "

The connection details, such as status, owner, and provider type.

" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#GetHost": { + "com.amazonaws.codestarconnections#DeleteHost": { "type": "operation", "input": { - "target": "com.amazonaws.codestarconnections#GetHostInput" + "target": "com.amazonaws.codestarconnections#DeleteHostInput" }, "output": { - "target": "com.amazonaws.codestarconnections#GetHostOutput" + "target": "com.amazonaws.codestarconnections#DeleteHostOutput" }, "errors": [ { @@ -1340,16 +1562,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the host ARN and details such as status, provider type, endpoint, and, if\n applicable, the VPC configuration.

" + "smithy.api#documentation": "

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

\n \n

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

\n " } }, - "com.amazonaws.codestarconnections#GetHostInput": { + "com.amazonaws.codestarconnections#DeleteHostInput": { "type": "structure", "members": { "HostArn": { "target": "com.amazonaws.codestarconnections#HostArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the requested host.

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

The Amazon Resource Name (ARN) of the host to be deleted.

", "smithy.api#required": {} } } @@ -1358,194 +1580,183 @@ "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#GetHostOutput": { + "com.amazonaws.codestarconnections#DeleteHostOutput": { "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.codestarconnections#HostName", - "traits": { - "smithy.api#documentation": "

The name of the requested host.

" - } + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#DeleteRepositoryLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#DeleteRepositoryLinkInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#DeleteRepositoryLinkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" }, - "Status": { - "target": "com.amazonaws.codestarconnections#HostStatus", - "traits": { - "smithy.api#documentation": "

The status of the requested host.

" - } + { + "target": "com.amazonaws.codestarconnections#ConcurrentModificationException" }, - "ProviderType": { - "target": "com.amazonaws.codestarconnections#ProviderType", - "traits": { - "smithy.api#documentation": "

The provider type of the requested host, such as GitHub Enterprise Server.

" - } + { + "target": "com.amazonaws.codestarconnections#InternalServerException" }, - "ProviderEndpoint": { - "target": "com.amazonaws.codestarconnections#Url", - "traits": { - "smithy.api#documentation": "

The endpoint of the infrastructure represented by the requested host.

" - } + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" }, - "VpcConfiguration": { - "target": "com.amazonaws.codestarconnections#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

The VPC configuration of the requested host.

" - } + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#SyncConfigurationStillExistsException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + }, + { + "target": "com.amazonaws.codestarconnections#UnsupportedProviderTypeException" } - }, + ], "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Deletes the association between your connection and a specified external Git repository.

" } }, - "com.amazonaws.codestarconnections#Host": { + "com.amazonaws.codestarconnections#DeleteRepositoryLinkInput": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.codestarconnections#HostName", + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", "traits": { - "smithy.api#documentation": "

The name of the host.

" + "smithy.api#documentation": "

The ID of the repository link to be deleted.

", + "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#DeleteRepositoryLinkOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#DeleteSyncConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#DeleteSyncConfigurationInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#DeleteSyncConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" }, - "HostArn": { - "target": "com.amazonaws.codestarconnections#HostArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host.

" - } + { + "target": "com.amazonaws.codestarconnections#ConcurrentModificationException" }, - "ProviderType": { - "target": "com.amazonaws.codestarconnections#ProviderType", - "traits": { - "smithy.api#documentation": "

The name of the installed provider to be associated with your connection. The host\n resource represents the infrastructure where your provider type is installed. The valid\n provider type is GitHub Enterprise Server.

" - } + { + "target": "com.amazonaws.codestarconnections#InternalServerException" }, - "ProviderEndpoint": { - "target": "com.amazonaws.codestarconnections#Url", - "traits": { - "smithy.api#documentation": "

The endpoint of the infrastructure where your provider type is installed.

" - } + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" }, - "VpcConfiguration": { - "target": "com.amazonaws.codestarconnections#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

The VPC configuration provisioned for the host.

" - } + { + "target": "com.amazonaws.codestarconnections#LimitExceededException" }, - "Status": { - "target": "com.amazonaws.codestarconnections#HostStatus", + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the sync configuration for a specified repository and connection.

" + } + }, + "com.amazonaws.codestarconnections#DeleteSyncConfigurationInput": { + "type": "structure", + "members": { + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", "traits": { - "smithy.api#documentation": "

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

" + "smithy.api#documentation": "

The type of sync configuration to be deleted.

", + "smithy.api#required": {} } }, - "StatusMessage": { - "target": "com.amazonaws.codestarconnections#HostStatusMessage", + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", "traits": { - "smithy.api#documentation": "

The status description for the host.

" + "smithy.api#documentation": "

The name of the Amazon Web Services resource associated with the sync configuration to be\n deleted.

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

A resource that represents the infrastructure where a third-party provider is installed.\n The host is used when you create connections to an installed third-party provider type, such\n as GitHub Enterprise Server. You create one host for all connections to that provider.

\n \n

A host created through the CLI or the SDK is in `PENDING` status by\n default. You can make its status `AVAILABLE` by setting up the host in the console.

\n " + "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#HostArn": { - "type": "string", + "com.amazonaws.codestarconnections#DeleteSyncConfigurationOutput": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+$" + "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#HostList": { - "type": "list", - "member": { - "target": "com.amazonaws.codestarconnections#Host" - } + "com.amazonaws.codestarconnections#DeploymentFilePath": { + "type": "string" }, - "com.amazonaws.codestarconnections#HostName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } + "com.amazonaws.codestarconnections#Directory": { + "type": "string" }, - "com.amazonaws.codestarconnections#HostStatus": { + "com.amazonaws.codestarconnections#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" + "min": 0, + "max": 600 + } } }, - "com.amazonaws.codestarconnections#HostStatusMessage": { + "com.amazonaws.codestarconnections#Event": { "type": "string" }, - "com.amazonaws.codestarconnections#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.codestarconnections#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Exceeded the maximum limit for connections.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } + "com.amazonaws.codestarconnections#ExternalId": { + "type": "string" }, - "com.amazonaws.codestarconnections#ListConnections": { + "com.amazonaws.codestarconnections#GetConnection": { "type": "operation", "input": { - "target": "com.amazonaws.codestarconnections#ListConnectionsInput" + "target": "com.amazonaws.codestarconnections#GetConnectionInput" }, "output": { - "target": "com.amazonaws.codestarconnections#ListConnectionsOutput" + "target": "com.amazonaws.codestarconnections#GetConnectionOutput" }, "errors": [ { "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Lists the connections associated with your account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "

Returns the connection ARN and details such as status, owner, and provider type.

" } }, - "com.amazonaws.codestarconnections#ListConnectionsInput": { + "com.amazonaws.codestarconnections#GetConnectionInput": { "type": "structure", "members": { - "ProviderTypeFilter": { - "target": "com.amazonaws.codestarconnections#ProviderType", - "traits": { - "smithy.api#documentation": "

Filters the list of connections to those associated with a specified provider, such as\n Bitbucket.

" - } - }, - "HostArnFilter": { - "target": "com.amazonaws.codestarconnections#HostArn", - "traits": { - "smithy.api#documentation": "

Filters the list of connections to those associated with a specified host.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.codestarconnections#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.codestarconnections#NextToken", + "ConnectionArn": { + "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "

The token that was returned from the previous ListConnections call, which\n can be used to return the next set of connections in the list.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a connection.

", + "smithy.api#required": {} } } }, @@ -1553,19 +1764,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#ListConnectionsOutput": { + "com.amazonaws.codestarconnections#GetConnectionOutput": { "type": "structure", "members": { - "Connections": { - "target": "com.amazonaws.codestarconnections#ConnectionList", - "traits": { - "smithy.api#documentation": "

A list of connections and the details for each connection, such as status, owner, and\n provider type.

" - } - }, - "NextToken": { - "target": "com.amazonaws.codestarconnections#NextToken", + "Connection": { + "target": "com.amazonaws.codestarconnections#Connection", "traits": { - "smithy.api#documentation": "

A token that can be used in the next ListConnections call. To view all\n items in the list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" + "smithy.api#documentation": "

The connection details, such as status, owner, and provider type.

" } } }, @@ -1573,37 +1778,34 @@ "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#ListHosts": { + "com.amazonaws.codestarconnections#GetHost": { "type": "operation", "input": { - "target": "com.amazonaws.codestarconnections#ListHostsInput" + "target": "com.amazonaws.codestarconnections#GetHostInput" }, "output": { - "target": "com.amazonaws.codestarconnections#ListHostsOutput" + "target": "com.amazonaws.codestarconnections#GetHostOutput" }, - "traits": { - "smithy.api#documentation": "

Lists the hosts associated with your account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" + "errors": [ + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceUnavailableException" } + ], + "traits": { + "smithy.api#documentation": "

Returns the host ARN and details such as status, provider type, endpoint, and, if\n applicable, the VPC configuration.

" } }, - "com.amazonaws.codestarconnections#ListHostsInput": { + "com.amazonaws.codestarconnections#GetHostInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.codestarconnections#MaxResults", + "HostArn": { + "target": "com.amazonaws.codestarconnections#HostArn", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.codestarconnections#NextToken", - "traits": { - "smithy.api#documentation": "

The token that was returned from the previous ListHosts call, which can be\n used to return the next set of hosts in the list.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the requested host.

", + "smithy.api#required": {} } } }, @@ -1611,19 +1813,37 @@ "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#ListHostsOutput": { + "com.amazonaws.codestarconnections#GetHostOutput": { "type": "structure", "members": { - "Hosts": { - "target": "com.amazonaws.codestarconnections#HostList", + "Name": { + "target": "com.amazonaws.codestarconnections#HostName", "traits": { - "smithy.api#documentation": "

A list of hosts and the details for each host, such as status, endpoint, and provider\n type.

" + "smithy.api#documentation": "

The name of the requested host.

" } }, - "NextToken": { - "target": "com.amazonaws.codestarconnections#NextToken", + "Status": { + "target": "com.amazonaws.codestarconnections#HostStatus", "traits": { - "smithy.api#documentation": "

A token that can be used in the next ListHosts call. To view all items in the\n list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" + "smithy.api#documentation": "

The status of the requested host.

" + } + }, + "ProviderType": { + "target": "com.amazonaws.codestarconnections#ProviderType", + "traits": { + "smithy.api#documentation": "

The provider type of the requested host, such as GitHub Enterprise Server.

" + } + }, + "ProviderEndpoint": { + "target": "com.amazonaws.codestarconnections#Url", + "traits": { + "smithy.api#documentation": "

The endpoint of the infrastructure represented by the requested host.

" + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.codestarconnections#VpcConfiguration", + "traits": { + "smithy.api#documentation": "

The VPC configuration of the requested host.

" } } }, @@ -1631,30 +1851,45 @@ "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#ListTagsForResource": { + "com.amazonaws.codestarconnections#GetRepositoryLink": { "type": "operation", "input": { - "target": "com.amazonaws.codestarconnections#ListTagsForResourceInput" + "target": "com.amazonaws.codestarconnections#GetRepositoryLinkInput" }, "output": { - "target": "com.amazonaws.codestarconnections#ListTagsForResourceOutput" + "target": "com.amazonaws.codestarconnections#GetRepositoryLinkOutput" }, "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, { "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Gets the set of key-value pairs (metadata) that are used to manage the resource.

" + "smithy.api#documentation": "

Returns details about a repository link. A repository link allows Git sync to monitor\n and sync changes from files in a specified Git repository.

" } }, - "com.amazonaws.codestarconnections#ListTagsForResourceInput": { + "com.amazonaws.codestarconnections#GetRepositoryLinkInput": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.codestarconnections#AmazonResourceName", + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.

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

The ID of the repository link to get.

", "smithy.api#required": {} } } @@ -1663,13 +1898,14 @@ "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#ListTagsForResourceOutput": { + "com.amazonaws.codestarconnections#GetRepositoryLinkOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.codestarconnections#TagList", + "RepositoryLinkInfo": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkInfo", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with the specified resource.

" + "smithy.api#documentation": "

The information returned for a specified repository link.

", + "smithy.api#required": {} } } }, @@ -1677,122 +1913,1701 @@ "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#MaxResults": { - "type": "integer", + "com.amazonaws.codestarconnections#GetRepositorySyncStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#GetRepositorySyncStatusInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#GetRepositorySyncStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 + "smithy.api#documentation": "

Returns details about the sync status for a repository. A repository sync uses Git sync\n to push and pull changes from your remote repository.

" + } + }, + "com.amazonaws.codestarconnections#GetRepositorySyncStatusInput": { + "type": "structure", + "members": { + "Branch": { + "target": "com.amazonaws.codestarconnections#BranchName", + "traits": { + "smithy.api#documentation": "

The branch of the repository link for the requested repository sync status.

", + "smithy.api#required": {} + } + }, + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The repository link ID for the requested repository sync status.

", + "smithy.api#required": {} + } + }, + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The sync type of the requested sync status.

", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#NextToken": { - "type": "string", + "com.amazonaws.codestarconnections#GetRepositorySyncStatusOutput": { + "type": "structure", + "members": { + "LatestSync": { + "target": "com.amazonaws.codestarconnections#RepositorySyncAttempt", + "traits": { + "smithy.api#documentation": "

The status of the latest sync returned for a specified repository and branch.

", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#GetResourceSyncStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#GetResourceSyncStatusInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#GetResourceSyncStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" }, - "smithy.api#pattern": ".*" + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the status of the sync with the Git repository for a specific Amazon Web Services\n resource.

" } }, - "com.amazonaws.codestarconnections#ProviderType": { - "type": "enum", + "com.amazonaws.codestarconnections#GetResourceSyncStatusInput": { + "type": "structure", "members": { - "BITBUCKET": { - "target": "smithy.api#Unit", + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", "traits": { - "smithy.api#enumValue": "Bitbucket" + "smithy.api#documentation": "

The name of the Amazon Web Services resource for the sync status with the Git\n repository.

", + "smithy.api#required": {} } }, - "GITHUB": { - "target": "smithy.api#Unit", + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", "traits": { - "smithy.api#enumValue": "GitHub" + "smithy.api#documentation": "

The sync type for the sync status with the Git repository.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#GetResourceSyncStatusOutput": { + "type": "structure", + "members": { + "DesiredState": { + "target": "com.amazonaws.codestarconnections#Revision", + "traits": { + "smithy.api#documentation": "

The desired state of the Amazon Web Services resource for the sync status with the Git\n repository.

" } }, - "GITHUB_ENTERPRISE_SERVER": { - "target": "smithy.api#Unit", + "LatestSuccessfulSync": { + "target": "com.amazonaws.codestarconnections#ResourceSyncAttempt", "traits": { - "smithy.api#enumValue": "GitHubEnterpriseServer" + "smithy.api#documentation": "

The latest successful sync for the sync status with the Git repository.

" } }, - "GITLAB": { - "target": "smithy.api#Unit", + "LatestSync": { + "target": "com.amazonaws.codestarconnections#ResourceSyncAttempt", "traits": { - "smithy.api#enumValue": "GitLab" + "smithy.api#documentation": "

The latest sync for the sync status with the Git repository, whether successful or not.

", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#ResourceNotFoundException": { + "com.amazonaws.codestarconnections#GetSyncBlockerSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#GetSyncBlockerSummaryInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#GetSyncBlockerSummaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the most recent sync blockers.

" + } + }, + "com.amazonaws.codestarconnections#GetSyncBlockerSummaryInput": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.codestarconnections#ErrorMessage" + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The sync type for the sync blocker summary.

", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services resource currently blocked from automatically being synced from a Git repository.

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

Resource not found. Verify the connection resource ARN and try again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#input": {} } }, - "com.amazonaws.codestarconnections#ResourceUnavailableException": { + "com.amazonaws.codestarconnections#GetSyncBlockerSummaryOutput": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.codestarconnections#ErrorMessage" + "SyncBlockerSummary": { + "target": "com.amazonaws.codestarconnections#SyncBlockerSummary", + "traits": { + "smithy.api#documentation": "

The list of sync blockers for a specified resource.

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

Resource not found. Verify the ARN for the host resource and try again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#output": {} } }, - "com.amazonaws.codestarconnections#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 11, - "max": 20 + "com.amazonaws.codestarconnections#GetSyncConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#GetSyncConfigurationInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#GetSyncConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" }, - "smithy.api#pattern": "^sg-\\w{8}(\\w{9})?$" + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.

" } }, - "com.amazonaws.codestarconnections#SecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.codestarconnections#SecurityGroupId" + "com.amazonaws.codestarconnections#GetSyncConfigurationInput": { + "type": "structure", + "members": { + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The sync type for the sync configuration for which you want to retrieve information.

", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services resource for the sync configuration for which you\n want to retrieve information.

", + "smithy.api#required": {} + } + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#GetSyncConfigurationOutput": { + "type": "structure", + "members": { + "SyncConfiguration": { + "target": "com.amazonaws.codestarconnections#SyncConfiguration", + "traits": { + "smithy.api#documentation": "

The details about the sync configuration for which you want to retrieve information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#Host": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.codestarconnections#HostName", + "traits": { + "smithy.api#documentation": "

The name of the host.

" + } + }, + "HostArn": { + "target": "com.amazonaws.codestarconnections#HostArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host.

" + } + }, + "ProviderType": { + "target": "com.amazonaws.codestarconnections#ProviderType", + "traits": { + "smithy.api#documentation": "

The name of the installed provider to be associated with your connection. The host\n resource represents the infrastructure where your provider type is installed. The valid\n provider type is GitHub Enterprise Server.

" + } + }, + "ProviderEndpoint": { + "target": "com.amazonaws.codestarconnections#Url", + "traits": { + "smithy.api#documentation": "

The endpoint of the infrastructure where your provider type is installed.

" + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.codestarconnections#VpcConfiguration", + "traits": { + "smithy.api#documentation": "

The VPC configuration provisioned for the host.

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

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.codestarconnections#HostStatusMessage", + "traits": { + "smithy.api#documentation": "

The status description for the host.

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

A resource that represents the infrastructure where a third-party provider is installed.\n The host is used when you create connections to an installed third-party provider type, such\n as GitHub Enterprise Server. You create one host for all connections to that provider.

\n \n

A host created through the CLI or the SDK is in `PENDING` status by\n default. You can make its status `AVAILABLE` by setting up the host in the console.

\n " + } + }, + "com.amazonaws.codestarconnections#HostArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+$" + } + }, + "com.amazonaws.codestarconnections#HostList": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#Host" + } + }, + "com.amazonaws.codestarconnections#HostName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.codestarconnections#HostStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.codestarconnections#HostStatusMessage": { + "type": "string" + }, + "com.amazonaws.codestarconnections#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:iam::\\d{12}:role/[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.codestarconnections#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.codestarconnections#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Received an internal server exception. Try again later.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.codestarconnections#InvalidInputException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The input is not valid. Verify that the action is typed correctly.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.codestarconnections#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:kms:[a-z\\-0-9]+:\\d{12}:key/[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.codestarconnections#LatestSyncBlockerList": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#SyncBlocker" + } + }, + "com.amazonaws.codestarconnections#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Exceeded the maximum limit for connections.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.codestarconnections#ListConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#ListConnectionsInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#ListConnectionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the connections associated with your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.codestarconnections#ListConnectionsInput": { + "type": "structure", + "members": { + "ProviderTypeFilter": { + "target": "com.amazonaws.codestarconnections#ProviderType", + "traits": { + "smithy.api#documentation": "

Filters the list of connections to those associated with a specified provider, such as\n Bitbucket.

" + } + }, + "HostArnFilter": { + "target": "com.amazonaws.codestarconnections#HostArn", + "traits": { + "smithy.api#documentation": "

Filters the list of connections to those associated with a specified host.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.codestarconnections#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

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

The token that was returned from the previous ListConnections call, which\n can be used to return the next set of connections in the list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#ListConnectionsOutput": { + "type": "structure", + "members": { + "Connections": { + "target": "com.amazonaws.codestarconnections#ConnectionList", + "traits": { + "smithy.api#documentation": "

A list of connections and the details for each connection, such as status, owner, and\n provider type.

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

A token that can be used in the next ListConnections call. To view all\n items in the list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#ListHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#ListHostsInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#ListHostsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the hosts associated with your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.codestarconnections#ListHostsInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.codestarconnections#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

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

The token that was returned from the previous ListHosts call, which can be\n used to return the next set of hosts in the list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#ListHostsOutput": { + "type": "structure", + "members": { + "Hosts": { + "target": "com.amazonaws.codestarconnections#HostList", + "traits": { + "smithy.api#documentation": "

A list of hosts and the details for each host, such as status, endpoint, and provider\n type.

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

A token that can be used in the next ListHosts call. To view all items in the\n list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#ListRepositoryLinks": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#ListRepositoryLinksInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#ListRepositoryLinksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the repository links created for connections in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.codestarconnections#ListRepositoryLinksInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.codestarconnections#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\nA non-zero, non-negative integer used to limit the number of returned results.

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

\nAn enumeration token that, when provided in a request, returns the next batch of the results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#ListRepositoryLinksOutput": { + "type": "structure", + "members": { + "RepositoryLinks": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkList", + "traits": { + "smithy.api#documentation": "

Lists the repository links called by the list repository links operation.

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

An enumeration token that allows the operation to batch the results of the operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#ListRepositorySyncDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#ListRepositorySyncDefinitionsInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#ListRepositorySyncDefinitionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the repository sync definitions for repository links in your account.

" + } + }, + "com.amazonaws.codestarconnections#ListRepositorySyncDefinitionsInput": { + "type": "structure", + "members": { + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The ID of the repository link for the sync definition for which you want to retrieve information.

", + "smithy.api#required": {} + } + }, + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The sync type of the repository link for the the sync definition for which you want to retrieve information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#ListRepositorySyncDefinitionsOutput": { + "type": "structure", + "members": { + "RepositorySyncDefinitions": { + "target": "com.amazonaws.codestarconnections#RepositorySyncDefinitionList", + "traits": { + "smithy.api#documentation": "

The list of repository sync definitions returned by the request. A\n RepositorySyncDefinition is a mapping from a repository branch to all the\n Amazon Web Services resources that are being synced from that branch.

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

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#ListSyncConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#ListSyncConfigurationsInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#ListSyncConfigurationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of sync configurations for a specified repository.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.codestarconnections#ListSyncConfigurationsInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.codestarconnections#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results.

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

An enumeration token that allows the operation to batch the results of the operation.

" + } + }, + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The ID of the repository link for the requested list of sync configurations.

", + "smithy.api#required": {} + } + }, + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The sync type for the requested list of sync configurations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#ListSyncConfigurationsOutput": { + "type": "structure", + "members": { + "SyncConfigurations": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of repository sync definitions returned by the request.

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

An enumeration token that allows the operation to batch the next results of the operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the set of key-value pairs (metadata) that are used to manage the resource.

" + } + }, + "com.amazonaws.codestarconnections#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.codestarconnections#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.codestarconnections#TagList", + "traits": { + "smithy.api#documentation": "

A list of tag key and value pairs associated with the specified resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.codestarconnections#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.codestarconnections#OwnerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.codestarconnections#Parent": { + "type": "string" + }, + "com.amazonaws.codestarconnections#ProviderType": { + "type": "enum", + "members": { + "BITBUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bitbucket" + } + }, + "GITHUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHub" + } + }, + "GITHUB_ENTERPRISE_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHubEnterpriseServer" + } + }, + "GITLAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitLab" + } + } + } + }, + "com.amazonaws.codestarconnections#RepositoryLinkArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:codestar-connections:[a-z\\-0-9]+:\\d{12}:repository-link\\/[a-zA-Z0-9\\-:/]+$" + } + }, + "com.amazonaws.codestarconnections#RepositoryLinkId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.codestarconnections#RepositoryLinkInfo": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.codestarconnections#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection associated with the repository link.

", + "smithy.api#required": {} + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.codestarconnections#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

" + } + }, + "OwnerId": { + "target": "com.amazonaws.codestarconnections#OwnerId", + "traits": { + "smithy.api#documentation": "

The owner ID for the repository associated with the repository link, such as the owner\n ID in GitHub.

", + "smithy.api#required": {} + } + }, + "ProviderType": { + "target": "com.amazonaws.codestarconnections#ProviderType", + "traits": { + "smithy.api#documentation": "

The provider type for the connection, such as GitHub, associated with the repository link.

", + "smithy.api#required": {} + } + }, + "RepositoryLinkArn": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the repository link.

", + "smithy.api#required": {} + } + }, + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The ID of the repository link.

", + "smithy.api#required": {} + } + }, + "RepositoryName": { + "target": "com.amazonaws.codestarconnections#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository associated with the repository link.

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

Information about the repository link resource, such as the repository link ARN, the associated connection ARN, encryption key ARN, and owner ID.

" + } + }, + "com.amazonaws.codestarconnections#RepositoryLinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkInfo" + } + }, + "com.amazonaws.codestarconnections#RepositoryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.codestarconnections#RepositorySyncAttempt": { + "type": "structure", + "members": { + "StartedAt": { + "target": "com.amazonaws.codestarconnections#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of a specific sync attempt.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.codestarconnections#RepositorySyncStatus", + "traits": { + "smithy.api#documentation": "

The status of a specific sync attempt. The following are valid statuses:

\n ", + "smithy.api#required": {} + } + }, + "Events": { + "target": "com.amazonaws.codestarconnections#RepositorySyncEventList", + "traits": { + "smithy.api#documentation": "

The events associated with a specific sync attempt.

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

Information about a repository sync attempt for a repository with a sync configuration.

" + } + }, + "com.amazonaws.codestarconnections#RepositorySyncDefinition": { + "type": "structure", + "members": { + "Branch": { + "target": "com.amazonaws.codestarconnections#BranchName", + "traits": { + "smithy.api#documentation": "

The branch specified for a repository sync definition.

", + "smithy.api#required": {} + } + }, + "Directory": { + "target": "com.amazonaws.codestarconnections#Directory", + "traits": { + "smithy.api#documentation": "

The configuration file for a repository sync definition. This value comes from creating\n or updating the config-file field of a sync-configuration.

", + "smithy.api#required": {} + } + }, + "Parent": { + "target": "com.amazonaws.codestarconnections#Parent", + "traits": { + "smithy.api#documentation": "

The parent resource specified for a repository sync definition.

", + "smithy.api#required": {} + } + }, + "Target": { + "target": "com.amazonaws.codestarconnections#Target", + "traits": { + "smithy.api#documentation": "

The target resource specified for a repository sync definition. In some cases, such as CFN_STACK_SYNC, the parent and target resource are the same.

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

The definition for a repository with a sync configuration.

" + } + }, + "com.amazonaws.codestarconnections#RepositorySyncDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#RepositorySyncDefinition" + } + }, + "com.amazonaws.codestarconnections#RepositorySyncEvent": { + "type": "structure", + "members": { + "Event": { + "target": "com.amazonaws.codestarconnections#Event", + "traits": { + "smithy.api#documentation": "

A description of a repository sync event.

", + "smithy.api#required": {} + } + }, + "ExternalId": { + "target": "com.amazonaws.codestarconnections#ExternalId", + "traits": { + "smithy.api#documentation": "

The ID for a repository sync event.

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

The time that a repository sync event occurred.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.codestarconnections#Type", + "traits": { + "smithy.api#documentation": "

The event type for a repository sync event.

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

Information about a repository sync event.

" + } + }, + "com.amazonaws.codestarconnections#RepositorySyncEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#RepositorySyncEvent" + } + }, + "com.amazonaws.codestarconnections#RepositorySyncStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIATED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + } + } + }, + "com.amazonaws.codestarconnections#ResolvedReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, + "com.amazonaws.codestarconnections#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Unable to create resource. Resource already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.codestarconnections#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\\\-]*$" + } + }, + "com.amazonaws.codestarconnections#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Resource not found. Verify the connection resource ARN and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.codestarconnections#ResourceSyncAttempt": { + "type": "structure", + "members": { + "Events": { + "target": "com.amazonaws.codestarconnections#ResourceSyncEventList", + "traits": { + "smithy.api#documentation": "

The events related to a resource sync attempt.

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

The current state of the resource as defined in the resource's config-file\n in the linked repository.

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

The start time for a resource sync attempt.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.codestarconnections#ResourceSyncStatus", + "traits": { + "smithy.api#documentation": "

The status for a resource sync attempt. The follow are valid statuses:

\n ", + "smithy.api#required": {} + } + }, + "TargetRevision": { + "target": "com.amazonaws.codestarconnections#Revision", + "traits": { + "smithy.api#documentation": "

The desired state of the resource as defined in the resource's config-file\n in the linked repository. Git sync attempts to update the resource to this state.

", + "smithy.api#required": {} + } + }, + "Target": { + "target": "com.amazonaws.codestarconnections#Target", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services resource that is attempted to be synchronized.

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

Information about a resource sync attempt.

" + } + }, + "com.amazonaws.codestarconnections#ResourceSyncEvent": { + "type": "structure", + "members": { + "Event": { + "target": "com.amazonaws.codestarconnections#Event", + "traits": { + "smithy.api#documentation": "

The event for a resource sync event.

", + "smithy.api#required": {} + } + }, + "ExternalId": { + "target": "com.amazonaws.codestarconnections#ExternalId", + "traits": { + "smithy.api#documentation": "

The ID for a resource sync event.

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

The time that a resource sync event occurred.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.codestarconnections#Type", + "traits": { + "smithy.api#documentation": "

The type of resource sync event.

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

Information about a resource sync event for the resource associated with a sync configuration.

" + } + }, + "com.amazonaws.codestarconnections#ResourceSyncEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#ResourceSyncEvent" + } + }, + "com.amazonaws.codestarconnections#ResourceSyncStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIATED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + } + } + }, + "com.amazonaws.codestarconnections#ResourceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Resource not found. Verify the ARN for the host resource and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.codestarconnections#RetryLatestCommitFailedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Retrying the latest commit failed. Try again later.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.codestarconnections#Revision": { + "type": "structure", + "members": { + "Branch": { + "target": "com.amazonaws.codestarconnections#BranchName", + "traits": { + "smithy.api#documentation": "

The branch name for a specific revision.

", + "smithy.api#required": {} + } + }, + "Directory": { + "target": "com.amazonaws.codestarconnections#Directory", + "traits": { + "smithy.api#documentation": "

The directory, if any, for a specific revision.

", + "smithy.api#required": {} + } + }, + "OwnerId": { + "target": "com.amazonaws.codestarconnections#OwnerId", + "traits": { + "smithy.api#documentation": "

The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.

", + "smithy.api#required": {} + } + }, + "RepositoryName": { + "target": "com.amazonaws.codestarconnections#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name for a specific revision.

", + "smithy.api#required": {} + } + }, + "ProviderType": { + "target": "com.amazonaws.codestarconnections#ProviderType", + "traits": { + "smithy.api#documentation": "

The provider type for a revision, such as GitHub.

", + "smithy.api#required": {} + } + }, + "Sha": { + "target": "com.amazonaws.codestarconnections#SHA", + "traits": { + "smithy.api#documentation": "

The SHA, such as the commit ID, for a specific revision.

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

Information about the revision for a specific sync event, such as the branch, owner ID, and name of the repository.

" + } + }, + "com.amazonaws.codestarconnections#SHA": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.codestarconnections#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 20 + }, + "smithy.api#pattern": "^sg-\\w{8}(\\w{9})?$" + } + }, + "com.amazonaws.codestarconnections#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.codestarconnections#SharpNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.codestarconnections#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 24 + }, + "smithy.api#pattern": "^subnet-\\w{8}(\\w{9})?$" + } + }, + "com.amazonaws.codestarconnections#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.codestarconnections#SyncBlocker": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.codestarconnections#Id", + "traits": { + "smithy.api#documentation": "

The ID for a specific sync blocker.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.codestarconnections#BlockerType", + "traits": { + "smithy.api#documentation": "

The sync blocker type.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.codestarconnections#BlockerStatus", + "traits": { + "smithy.api#documentation": "

The status for a specific sync blocker.

", + "smithy.api#required": {} + } + }, + "CreatedReason": { + "target": "com.amazonaws.codestarconnections#CreatedReason", + "traits": { + "smithy.api#documentation": "

The provided reason for a specific sync blocker.

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

The creation time for a specific sync blocker.

", + "smithy.api#required": {} + } + }, + "Contexts": { + "target": "com.amazonaws.codestarconnections#SyncBlockerContextList", + "traits": { + "smithy.api#documentation": "

The contexts for a specific sync blocker.

" + } + }, + "ResolvedReason": { + "target": "com.amazonaws.codestarconnections#ResolvedReason", + "traits": { + "smithy.api#documentation": "

The resolved reason for a specific sync blocker.

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

The time that a specific sync blocker was resolved.

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

Information about a blocker for a sync event.

" + } + }, + "com.amazonaws.codestarconnections#SyncBlockerContext": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.codestarconnections#SyncBlockerContextKey", + "traits": { + "smithy.api#documentation": "

The key provided for a context key-value pair for a specific sync blocker.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.codestarconnections#SyncBlockerContextValue", + "traits": { + "smithy.api#documentation": "

The value provided for a context key-value pair for a specific sync blocker.

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

The context for a specific sync blocker.

" + } + }, + "com.amazonaws.codestarconnections#SyncBlockerContextKey": { + "type": "string" + }, + "com.amazonaws.codestarconnections#SyncBlockerContextList": { + "type": "list", + "member": { + "target": "com.amazonaws.codestarconnections#SyncBlockerContext" + } + }, + "com.amazonaws.codestarconnections#SyncBlockerContextValue": { + "type": "string" + }, + "com.amazonaws.codestarconnections#SyncBlockerDoesNotExistException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Unable to continue. The sync blocker does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.codestarconnections#SyncBlockerSummary": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name for sync blocker summary.

", + "smithy.api#required": {} + } + }, + "ParentResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The parent resource name for a sync blocker summary.

" + } + }, + "LatestBlockers": { + "target": "com.amazonaws.codestarconnections#LatestSyncBlockerList", + "traits": { + "smithy.api#documentation": "

The latest events for a sync blocker summary.

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

A summary for sync blockers.

" + } + }, + "com.amazonaws.codestarconnections#SyncConfiguration": { + "type": "structure", + "members": { + "Branch": { + "target": "com.amazonaws.codestarconnections#BranchName", + "traits": { + "smithy.api#documentation": "

The branch associated with a specific sync configuration.

", + "smithy.api#required": {} + } + }, + "ConfigFile": { + "target": "com.amazonaws.codestarconnections#DeploymentFilePath", + "traits": { + "smithy.api#documentation": "

The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

" + } + }, + "OwnerId": { + "target": "com.amazonaws.codestarconnections#OwnerId", + "traits": { + "smithy.api#documentation": "

The owner ID for the repository associated with a specific sync configuration, such as\n the owner ID in GitHub.

", + "smithy.api#required": {} + } + }, + "ProviderType": { + "target": "com.amazonaws.codestarconnections#ProviderType", + "traits": { + "smithy.api#documentation": "

The connection provider type associated with a specific sync configuration, such as\n GitHub.

", + "smithy.api#required": {} + } + }, + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The ID of the repository link associated with a specific sync configuration.

", + "smithy.api#required": {} + } + }, + "RepositoryName": { + "target": "com.amazonaws.codestarconnections#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository associated with a specific sync configuration.

", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the connection resource associated with a specific sync configuration.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.codestarconnections#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

", + "smithy.api#required": {} + } + }, + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The type of sync for a specific sync configuration.

", + "smithy.api#required": {} + } } - } - }, - "com.amazonaws.codestarconnections#SubnetId": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 15, - "max": 24 - }, - "smithy.api#pattern": "^subnet-\\w{8}(\\w{9})?$" + "smithy.api#documentation": "

Information, such as repository, branch, provider, and resource names for a specific sync configuration.

" } }, - "com.amazonaws.codestarconnections#SubnetIds": { + "com.amazonaws.codestarconnections#SyncConfigurationList": { "type": "list", "member": { - "target": "com.amazonaws.codestarconnections#SubnetId" + "target": "com.amazonaws.codestarconnections#SyncConfiguration" + } + }, + "com.amazonaws.codestarconnections#SyncConfigurationStillExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 + "smithy.api#documentation": "

Unable to continue. The sync blocker still exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.codestarconnections#SyncConfigurationType": { + "type": "enum", + "members": { + "CFN_STACK_SYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CFN_STACK_SYNC" + } } } }, @@ -1911,6 +3726,25 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.codestarconnections#Target": { + "type": "string" + }, + "com.amazonaws.codestarconnections#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.codestarconnections#Timestamp": { + "type": "timestamp" + }, "com.amazonaws.codestarconnections#TlsCertificate": { "type": "string", "traits": { @@ -1921,6 +3755,9 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.codestarconnections#Type": { + "type": "string" + }, "com.amazonaws.codestarconnections#UnsupportedOperationException": { "type": "structure", "members": { @@ -1934,6 +3771,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.codestarconnections#UnsupportedProviderTypeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified provider type is not supported for connections.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.codestarconnections#UntagResource": { "type": "operation", "input": { @@ -2040,6 +3890,291 @@ "smithy.api#output": {} } }, + "com.amazonaws.codestarconnections#UpdateOutOfSyncException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.codestarconnections#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The update is out of sync. Try syncing again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.codestarconnections#UpdateRepositoryLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#UpdateRepositoryLinkInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#UpdateRepositoryLinkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + }, + { + "target": "com.amazonaws.codestarconnections#UpdateOutOfSyncException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the association between your connection and a specified external Git repository.\n A repository link allows Git sync to monitor and sync changes to files in a specified Git\n repository.

" + } + }, + "com.amazonaws.codestarconnections#UpdateRepositoryLinkInput": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.codestarconnections#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection for the repository link to be updated. The updated connection ARN must have the same providerType (such as GitHub) as the original connection ARN for the repo link.

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.codestarconnections#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the encryption key for the repository link to be updated.

" + } + }, + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The ID of the repository link to be updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#UpdateRepositoryLinkOutput": { + "type": "structure", + "members": { + "RepositoryLinkInfo": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkInfo", + "traits": { + "smithy.api#documentation": "

Information about the repository link to be updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#UpdateSyncBlocker": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#UpdateSyncBlockerInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#UpdateSyncBlockerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#RetryLatestCommitFailedException" + }, + { + "target": "com.amazonaws.codestarconnections#SyncBlockerDoesNotExistException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.

" + } + }, + "com.amazonaws.codestarconnections#UpdateSyncBlockerInput": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.codestarconnections#Id", + "traits": { + "smithy.api#documentation": "

The ID of the sync blocker to be updated.

", + "smithy.api#required": {} + } + }, + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The sync type of the sync blocker to be updated.

", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource for the sync blocker to be updated.

", + "smithy.api#required": {} + } + }, + "ResolvedReason": { + "target": "com.amazonaws.codestarconnections#ResolvedReason", + "traits": { + "smithy.api#documentation": "

The reason for resolving the sync blocker.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#UpdateSyncBlockerOutput": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name for the sync blocker.

", + "smithy.api#required": {} + } + }, + "ParentResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The parent resource name for the sync blocker.

" + } + }, + "SyncBlocker": { + "target": "com.amazonaws.codestarconnections#SyncBlocker", + "traits": { + "smithy.api#documentation": "

Information about the sync blocker to be updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codestarconnections#UpdateSyncConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codestarconnections#UpdateSyncConfigurationInput" + }, + "output": { + "target": "com.amazonaws.codestarconnections#UpdateSyncConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#AccessDeniedException" + }, + { + "target": "com.amazonaws.codestarconnections#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.codestarconnections#InternalServerException" + }, + { + "target": "com.amazonaws.codestarconnections#InvalidInputException" + }, + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codestarconnections#ThrottlingException" + }, + { + "target": "com.amazonaws.codestarconnections#UpdateOutOfSyncException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the sync configuration for your connection and a specified external Git repository.

" + } + }, + "com.amazonaws.codestarconnections#UpdateSyncConfigurationInput": { + "type": "structure", + "members": { + "Branch": { + "target": "com.amazonaws.codestarconnections#BranchName", + "traits": { + "smithy.api#documentation": "

The branch for the sync configuration to be updated.

" + } + }, + "ConfigFile": { + "target": "com.amazonaws.codestarconnections#DeploymentFilePath", + "traits": { + "smithy.api#documentation": "

The configuration file for the sync configuration to be updated.

" + } + }, + "RepositoryLinkId": { + "target": "com.amazonaws.codestarconnections#RepositoryLinkId", + "traits": { + "smithy.api#documentation": "

The ID of the repository link for the sync configuration to be updated.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.codestarconnections#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services resource for the sync configuration to be\n updated.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.codestarconnections#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role for the sync configuration to be updated.

" + } + }, + "SyncType": { + "target": "com.amazonaws.codestarconnections#SyncConfigurationType", + "traits": { + "smithy.api#documentation": "

The sync type for the sync configuration to be updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codestarconnections#UpdateSyncConfigurationOutput": { + "type": "structure", + "members": { + "SyncConfiguration": { + "target": "com.amazonaws.codestarconnections#SyncConfiguration", + "traits": { + "smithy.api#documentation": "

The information returned for the sync configuration to be updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codestarconnections#Url": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index db493ea282d..1e8079f9656 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -15340,6 +15340,12 @@ "smithy.api#enumValue": "WISDOM_KNOWLEDGE_BASE" } }, + "WISDOM_QUICK_RESPONSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WISDOM_QUICK_RESPONSES" + } + }, "CASES_DOMAIN": { "target": "smithy.api#Unit", "traits": { @@ -16651,12 +16657,6 @@ "com.amazonaws.connect#ListFlowAssociationResourceType": { "type": "enum", "members": { - "SMS_PHONE_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMS_PHONE_NUMBER" - } - }, "VOICE_PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk-codegen/aws-models/dlm.json b/codegen/sdk-codegen/aws-models/dlm.json index 951f8d032b9..235ee067f33 100644 --- a/codegen/sdk-codegen/aws-models/dlm.json +++ b/codegen/sdk-codegen/aws-models/dlm.json @@ -1860,14 +1860,14 @@ "ExecutionHandlerService": { "target": "com.amazonaws.dlm#ExecutionHandlerServiceValues", "traits": { - "smithy.api#documentation": "

Indicates the service used to execute the pre and/or post scripts.

\n \n

Default: AWS_SYSTEMS_MANAGER

" + "smithy.api#documentation": "

Indicates the service used to execute the pre and/or post scripts.

\n \n

Default: AWS_SYSTEMS_MANAGER

" } }, "ExecutionHandler": { "target": "com.amazonaws.dlm#ExecutionHandler", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The SSM document that includes the pre and/or post scripts to run.

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

The SSM document that includes the pre and/or post scripts to run.

\n ", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 326c24105c8..fcb1afaa077 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -1449,6 +1449,12 @@ "smithy.api#required": {} } }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The public 2-byte or 4-byte ASN that you want to advertise.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -1820,6 +1826,13 @@ "smithy.api#documentation": "

A preview of the next available CIDR in a pool.

" } }, + "AllowedCidrs": { + "target": "com.amazonaws.ec2#IpamPoolAllocationAllowedCidrs", + "traits": { + "smithy.api#documentation": "

Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

", + "smithy.api#xmlName": "AllowedCidr" + } + }, "DisallowedCidrs": { "target": "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs", "traits": { @@ -2155,6 +2168,9 @@ { "target": "com.amazonaws.ec2#AssociateInstanceEventWindow" }, + { + "target": "com.amazonaws.ec2#AssociateIpamByoasn" + }, { "target": "com.amazonaws.ec2#AssociateIpamResourceDiscovery" }, @@ -2725,6 +2741,9 @@ { "target": "com.amazonaws.ec2#DeprovisionByoipCidr" }, + { + "target": "com.amazonaws.ec2#DeprovisionIpamByoasn" + }, { "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidr" }, @@ -2911,6 +2930,9 @@ { "target": "com.amazonaws.ec2#DescribeInternetGateways" }, + { + "target": "com.amazonaws.ec2#DescribeIpamByoasn" + }, { "target": "com.amazonaws.ec2#DescribeIpamPools" }, @@ -3265,6 +3287,9 @@ { "target": "com.amazonaws.ec2#DisassociateInstanceEventWindow" }, + { + "target": "com.amazonaws.ec2#DisassociateIpamByoasn" + }, { "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscovery" }, @@ -3409,6 +3434,9 @@ { "target": "com.amazonaws.ec2#GetIpamDiscoveredAccounts" }, + { + "target": "com.amazonaws.ec2#GetIpamDiscoveredPublicAddresses" + }, { "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs" }, @@ -3724,6 +3752,9 @@ { "target": "com.amazonaws.ec2#ProvisionByoipCidr" }, + { + "target": "com.amazonaws.ec2#ProvisionIpamByoasn" + }, { "target": "com.amazonaws.ec2#ProvisionIpamPoolCidr" }, @@ -5633,6 +5664,161 @@ } } }, + "com.amazonaws.ec2#AsnAssociation": { + "type": "structure", + "members": { + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Asn", + "smithy.api#documentation": "

The association's ASN.

", + "smithy.api#xmlName": "asn" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The association's CIDR.

", + "smithy.api#xmlName": "cidr" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The association's status message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "State": { + "target": "com.amazonaws.ec2#AsnAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The association's state.

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

An Autonomous System Number (ASN) and BYOIP CIDR association.

" + } + }, + "com.amazonaws.ec2#AsnAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AsnAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AsnAssociationState": { + "type": "enum", + "members": { + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failed_disassociation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-disassociation" + } + }, + "failed_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-association" + } + }, + "pending_disassociation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-disassociation" + } + }, + "pending_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-association" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + } + } + }, + "com.amazonaws.ec2#AsnAuthorizationContext": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The authorization context's message.

", + "smithy.api#required": {} + } + }, + "Signature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The authorization context's signature.

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

Provides authorization for Amazon to bring an Autonomous System Number (ASN) to a specific Amazon Web Services account using bring your own ASN (BYOASN). \n For details on the format of the message and signature, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#AsnState": { + "type": "enum", + "members": { + "deprovisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deprovisioned" + } + }, + "failed_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-deprovision" + } + }, + "failed_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-provision" + } + }, + "pending_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-deprovision" + } + }, + "pending_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-provision" + } + }, + "provisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned" + } + } + } + }, "com.amazonaws.ec2#AssetId": { "type": "string" }, @@ -6374,6 +6560,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#AssociateIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. \n For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

\n

After the association succeeds, the ASN is eligible for \n advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.

" + } + }, + "com.amazonaws.ec2#AssociateIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The BYOIP CIDR you want to associate with an ASN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateIpamByoasnResult": { + "type": "structure", + "members": { + "AsnAssociation": { + "target": "com.amazonaws.ec2#AsnAssociation", + "traits": { + "aws.protocols#ec2QueryName": "AsnAssociation", + "smithy.api#documentation": "

The ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "asnAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#AssociateIpamResourceDiscovery": { "type": "operation", "input": { @@ -6618,7 +6862,7 @@ "target": "com.amazonaws.ec2#AssociateSubnetCidrBlockResult" }, "traits": { - "smithy.api#documentation": "

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR\n block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

" + "smithy.api#documentation": "

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR\n block with your subnet.

" } }, "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest": { @@ -6628,9 +6872,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix\n length.

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

The IPv6 CIDR block for your subnet.

", "smithy.api#xmlName": "ipv6CidrBlock" } }, @@ -6643,6 +6885,18 @@ "smithy.api#required": {}, "smithy.api#xmlName": "subnetId" } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

An IPv6 IPAM pool ID.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

An IPv6 netmask length.

" + } } }, "traits": { @@ -6864,7 +7118,7 @@ "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

" + "smithy.api#documentation": "

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

" } }, "com.amazonaws.ec2#AssociateTrunkInterfaceRequest": { @@ -6949,7 +7203,7 @@ "target": "com.amazonaws.ec2#AssociateVpcCidrBlockResult" }, "traits": { - "smithy.api#documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed\n at /56.

\n

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.

\n

For more information about associating CIDR blocks with your VPC and applicable\n restrictions, see IP addressing for your VPCs and subnets \n in the Amazon VPC User Guide.

" + "smithy.api#documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP).

\n

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.

\n

For more information about associating CIDR blocks with your VPC and applicable\n restrictions, see IP addressing for your VPCs and subnets \n in the Amazon VPC User Guide.

" } }, "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { @@ -6959,7 +7213,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", - "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

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

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You\n cannot specify the range of IPv6 addresses or the size of the CIDR block.

", "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" } }, @@ -7737,7 +7991,7 @@ } }, "traits": { - "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the\n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.\n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same\n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the\n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets\n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express\n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" } }, "com.amazonaws.ec2#AttachmentEnaSrdUdpSpecification": { @@ -7747,13 +8001,13 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "EnaSrdUdpEnabled", - "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

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

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting,\n\t\t\tyou must first enable ENA Express.

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

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic\n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are\n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time\n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application\n\t\t\tenvironment needs.

" } }, "com.amazonaws.ec2#AttachmentStatus": { @@ -9067,6 +9321,55 @@ "com.amazonaws.ec2#BurstablePerformanceFlag": { "type": "boolean" }, + "com.amazonaws.ec2#Byoasn": { + "type": "structure", + "members": { + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Asn", + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#xmlName": "asn" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

An IPAM ID.

", + "smithy.api#xmlName": "ipamId" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "State": { + "target": "com.amazonaws.ec2#AsnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The provisioning state of the BYOASN.

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

The Autonomous System Number (ASN) and BYOIP CIDR association.

" + } + }, + "com.amazonaws.ec2#ByoasnSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Byoasn", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#ByoipCidr": { "type": "structure", "members": { @@ -9086,6 +9389,14 @@ "smithy.api#xmlName": "description" } }, + "AsnAssociations": { + "target": "com.amazonaws.ec2#AsnAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "AsnAssociationSet", + "smithy.api#documentation": "

The BYOIP CIDR associations with ASNs.

", + "smithy.api#xmlName": "asnAssociationSet" + } + }, "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { @@ -12666,6 +12977,128 @@ } } }, + "com.amazonaws.ec2#ConnectionTrackingConfiguration": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TcpEstablishedTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

", + "smithy.api#xmlName": "tcpEstablishedTimeout" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpStreamTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

", + "smithy.api#xmlName": "udpStreamTimeout" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

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

A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ConnectionTrackingSpecification": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TcpEstablishedTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

", + "smithy.api#xmlName": "tcpEstablishedTimeout" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

", + "smithy.api#xmlName": "udpTimeout" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpStreamTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

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

A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

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

A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ConnectionTrackingSpecificationResponse": { + "type": "structure", + "members": { + "TcpEstablishedTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TcpEstablishedTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle TCP\n\t\t\t\t\t\tconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\n\t\t\t\t\t\tdays). Default: 432000 seconds. Recommended: Less than 432000 seconds.

", + "smithy.api#xmlName": "tcpEstablishedTimeout" + } + }, + "UdpStreamTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpStreamTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP\n\t\t\t\t\t\tflows classified as streams which have seen more than one request-response\n\t\t\t\t\t\ttransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\n\t\t\t\t\t\tseconds.

", + "smithy.api#xmlName": "udpStreamTimeout" + } + }, + "UdpTimeout": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UdpTimeout", + "smithy.api#documentation": "

Timeout (in seconds) for idle UDP flows that\n\t\t\t\t\t\thave seen traffic only in a single direction or a single request-response\n\t\t\t\t\t\ttransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

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

A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

" + } + }, "com.amazonaws.ec2#ConnectivityType": { "type": "enum", "members": { @@ -15389,6 +15822,12 @@ "traits": { "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

" } + }, + "SourceResource": { + "target": "com.amazonaws.ec2#IpamPoolSourceResourceRequest", + "traits": { + "smithy.api#documentation": "

The resource used to provision CIDRs to a resource planning pool.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", "smithy.api#idempotencyToken": {} } + }, + "Tier": { + "target": "com.amazonaws.ec2#IpamTier", + "traits": { + "smithy.api#documentation": "

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

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

If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that\n this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services\n will automatically assign an IPv6 address associated with the ENI attached to your\n instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a\n primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary\n IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is\n terminated or the network interface is detached. If you have multiple IPv6 addresses\n associated with an ENI attached to your instance and you enable a primary IPv6 address,\n the first IPv6 GUA address associated with the ENI becomes the primary IPv6\n address.

" } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A connection tracking specification for the network interface.

" + } } }, "traits": { @@ -18098,7 +18549,7 @@ "target": "com.amazonaws.ec2#CreateSubnetResult" }, "traits": { - "smithy.api#documentation": "

Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.\n If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead.\n For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both\n an IPv4 CIDR block and an IPv6 CIDR block.

\n

A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC.\n After you create a subnet, you can't change its CIDR block.

\n

The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and \n a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and \n the last IPv4 address in each subnet's CIDR block. They're not available for your use.

\n

If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block \n with a subnet when you create it. The allowed block size for an IPv6 subnet is a /64 netmask.

\n

If you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.

\n

When you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.

\n

For more information, see Subnets in the Amazon VPC User Guide.

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

Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.\n If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead.\n For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both\n an IPv4 CIDR block and an IPv6 CIDR block.

\n

A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC.\n After you create a subnet, you can't change its CIDR block.

\n

The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and \n a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and \n the last IPv4 address in each subnet's CIDR block. They're not available for your use.

\n

If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR\n block with a subnet when you create it.

\n

If you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.

\n

When you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.

\n

For more information, see Subnets in the Amazon VPC User Guide.

", "smithy.api#examples": [ { "title": "To create a subnet", @@ -18231,7 +18682,7 @@ "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.

\n

This parameter is required for an IPv6 only subnet.

" + "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. This parameter is required\n for an IPv6 only subnet.

" } }, "OutpostArn": { @@ -18261,6 +18712,30 @@ "traits": { "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet.

" } + }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

An IPv4 IPAM pool ID for the subnet.

" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

An IPv4 netmask length for the subnet.

" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

An IPv6 IPAM pool ID for the subnet.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

An IPv6 netmask length for the subnet.

" + } } }, "traits": { @@ -20312,7 +20787,7 @@ "target": "com.amazonaws.ec2#CreateVpcResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the \n Amazon VPC User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).

\n

By default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon VPC User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon EC2 User Guide.

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

Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the \n Amazon VPC User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an\n Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR\n block from an IPv6 address pool that you provisioned through bring your own IP addresses\n (BYOIP).

\n

By default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon VPC User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon EC2 User Guide.

", "smithy.api#examples": [ { "title": "To create a VPC", @@ -22315,6 +22790,12 @@ "smithy.api#documentation": "

The ID of the pool to delete.

", "smithy.api#required": {} } + }, + "Cascade": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enables you to quickly delete an IPAM pool and all resources within that pool, including\n provisioned CIDRs, allocations, and other pools.

\n \n

You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.

\n " + } } }, "traits": { @@ -25635,6 +26116,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DeprovisionIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn.\n For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#DeprovisionIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPAM ID.

", + "smithy.api#required": {} + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An ASN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionIpamByoasnResult": { + "type": "structure", + "members": { + "Byoasn": { + "target": "com.amazonaws.ec2#Byoasn", + "traits": { + "aws.protocols#ec2QueryName": "Byoasn", + "smithy.api#documentation": "

An ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "byoasn" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DeprovisionIpamPoolCidr": { "type": "operation", "input": { @@ -31577,6 +32116,77 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DescribeIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#DescribeIpamByoasnMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeIpamByoasnMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

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

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamByoasnResult": { + "type": "structure", + "members": { + "Byoasns": { + "target": "com.amazonaws.ec2#ByoasnSet", + "traits": { + "aws.protocols#ec2QueryName": "ByoasnSet", + "smithy.api#documentation": "

ASN and BYOIP CIDR associations.

", + "smithy.api#xmlName": "byoasnSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DescribeIpamPools": { "type": "operation", "input": { @@ -38574,7 +39184,7 @@ "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult" }, "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Describes one or more network interface trunk associations.

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

Describes one or more network interface trunk associations.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -42790,6 +43400,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisassociateIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. \n For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#DisassociateIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A BYOIP CIDR.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateIpamByoasnResult": { + "type": "structure", + "members": { + "AsnAssociation": { + "target": "com.amazonaws.ec2#AsnAssociation", + "traits": { + "aws.protocols#ec2QueryName": "AsnAssociation", + "smithy.api#documentation": "

An ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "asnAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DisassociateIpamResourceDiscovery": { "type": "operation", "input": { @@ -43205,7 +43873,7 @@ "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Removes an association between a branch network interface with a trunk network interface.

" + "smithy.api#documentation": "

Removes an association between a branch network interface with a trunk network interface.

" } }, "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { @@ -44666,7 +45334,7 @@ } }, "traits": { - "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the\n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.\n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same\n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the\n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets\n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express\n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" } }, "com.amazonaws.ec2#EnaSrdSpecificationRequest": { @@ -44698,12 +45366,12 @@ "EnaSrdUdpEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

" + "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting,\n\t\t\tyou must first enable ENA Express.

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

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic\n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are\n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time\n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application\n\t\t\tenvironment needs.

" } }, "com.amazonaws.ec2#EnaSrdUdpSpecificationRequest": { @@ -50647,6 +51315,99 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#GetIpamDiscoveredPublicAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the public IP addresses that have been discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An IPAM resource discovery ID.

", + "smithy.api#required": {} + } + }, + "AddressRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services Region for the IP address.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of IPAM discovered public addresses to return in one page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredPublicAddressesResult": { + "type": "structure", + "members": { + "IpamDiscoveredPublicAddresses": { + "target": "com.amazonaws.ec2#IpamDiscoveredPublicAddressSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamDiscoveredPublicAddressSet", + "smithy.api#documentation": "

IPAM discovered public addresses.

", + "smithy.api#xmlName": "ipamDiscoveredPublicAddressSet" + } + }, + "OldestSampleTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OldestSampleTime", + "smithy.api#documentation": "

The oldest successful resource discovery time.

", + "smithy.api#xmlName": "oldestSampleTime" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs": { "type": "operation", "input": { @@ -56193,7 +56954,7 @@ "target": "com.amazonaws.ec2#PlatformValues", "traits": { "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances; otherwise blank.

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

The platform. This value is windows for Windows instances; otherwise, it is empty.

", "smithy.api#xmlName": "platform" } }, @@ -56599,7 +57360,7 @@ } }, "traits": { - "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the\n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.\n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same\n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the\n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets\n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express\n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" } }, "com.amazonaws.ec2#InstanceAttachmentEnaSrdUdpSpecification": { @@ -56609,13 +57370,13 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "EnaSrdUdpEnabled", - "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

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

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting,\n\t\t\tyou must first enable ENA Express.

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

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic\n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are\n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time\n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application\n\t\t\tenvironment needs.

" } }, "com.amazonaws.ec2#InstanceAttribute": { @@ -58172,6 +58933,14 @@ "smithy.api#documentation": "

The IPv6 delegated prefixes that are assigned to the network interface.

", "smithy.api#xmlName": "ipv6PrefixSet" } + }, + "ConnectionTrackingConfiguration": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionTrackingConfiguration", + "smithy.api#documentation": "

A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "connectionTrackingConfiguration" + } } }, "traits": { @@ -58281,7 +59050,7 @@ "target": "com.amazonaws.ec2#InstanceAttachmentEnaSrdSpecification", "traits": { "aws.protocols#ec2QueryName": "EnaSrdSpecification", - "smithy.api#documentation": "

Contains the ENA Express settings for the network interface that's attached \n\t\t\tto the instance.

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

Contains the ENA Express settings for the network interface that's attached\n\t\t\tto the instance.

", "smithy.api#xmlName": "enaSrdSpecification" } } @@ -58450,7 +59219,13 @@ "EnaSrdSpecification": { "target": "com.amazonaws.ec2#EnaSrdSpecificationRequest", "traits": { - "smithy.api#documentation": "

Specifies the ENA Express settings for the network interface that's attached to \n\t\t\tthe instance.

" + "smithy.api#documentation": "

Specifies the ENA Express settings for the network interface that's attached to\n\t\t\tthe instance.

" + } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

" } } }, @@ -64846,6 +65621,22 @@ "smithy.api#documentation": "

The IPAM's resource discovery association count.

", "smithy.api#xmlName": "resourceDiscoveryAssociationCount" } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The state message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "Tier": { + "target": "com.amazonaws.ec2#IpamTier", + "traits": { + "aws.protocols#ec2QueryName": "Tier", + "smithy.api#documentation": "

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

", + "smithy.api#xmlName": "tier" + } } }, "traits": { @@ -65124,6 +65915,175 @@ } } }, + "com.amazonaws.ec2#IpamDiscoveredPublicAddress": { + "type": "structure", + "members": { + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "AddressRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressRegion", + "smithy.api#documentation": "

The Region of the resource the IP address is assigned to.

", + "smithy.api#xmlName": "addressRegion" + } + }, + "Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

The IP address.

", + "smithy.api#xmlName": "address" + } + }, + "AddressOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressOwnerId", + "smithy.api#documentation": "

The ID of the owner of the resource the IP address is assigned to.

", + "smithy.api#xmlName": "addressOwnerId" + } + }, + "AddressAllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressAllocationId", + "smithy.api#documentation": "

The allocation ID of the resource the IP address is assigned to.

", + "smithy.api#xmlName": "addressAllocationId" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.ec2#IpamPublicAddressAssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "AssociationStatus", + "smithy.api#documentation": "

The association status.

", + "smithy.api#xmlName": "associationStatus" + } + }, + "AddressType": { + "target": "com.amazonaws.ec2#IpamPublicAddressType", + "traits": { + "aws.protocols#ec2QueryName": "AddressType", + "smithy.api#documentation": "

The IP address type.

", + "smithy.api#xmlName": "addressType" + } + }, + "Service": { + "target": "com.amazonaws.ec2#IpamPublicAddressAwsService", + "traits": { + "aws.protocols#ec2QueryName": "Service", + "smithy.api#documentation": "

The Amazon Web Services service associated with the IP address.

", + "smithy.api#xmlName": "service" + } + }, + "ServiceResource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceResource", + "smithy.api#documentation": "

The resource ARN or ID.

", + "smithy.api#xmlName": "serviceResource" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC that the resource with the assigned IP address is in.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet that the resource with the assigned IP address is in.

", + "smithy.api#xmlName": "subnetId" + } + }, + "PublicIpv4PoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4PoolId", + "smithy.api#documentation": "

The ID of the public IPv4 pool that the resource with the assigned IP address is from.

", + "smithy.api#xmlName": "publicIpv4PoolId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The network interface ID of the resource with the assigned IP address.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "NetworkInterfaceDescription": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceDescription", + "smithy.api#documentation": "

The description of the network interface that IP address is assigned to.

", + "smithy.api#xmlName": "networkInterfaceDescription" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The instance ID of the instance the assigned IP address is assigned to.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#IpamPublicAddressTags", + "traits": { + "aws.protocols#ec2QueryName": "Tags", + "smithy.api#documentation": "

Tags associated with the IP address.

", + "smithy.api#xmlName": "tags" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The network border group that the resource that the IP address is assigned to is in.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#IpamPublicAddressSecurityGroupList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupSet", + "smithy.api#documentation": "

Security groups associated with the resource that the IP address is assigned to.

", + "smithy.api#xmlName": "securityGroupSet" + } + }, + "SampleTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampleTime", + "smithy.api#documentation": "

The last successful resource discovery time.

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

A public IP Address discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#IpamDiscoveredPublicAddressSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamDiscoveredPublicAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#IpamDiscoveredResourceCidr": { "type": "structure", "members": { @@ -65455,7 +66415,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "StateMessage", - "smithy.api#documentation": "

A message related to the failed creation of an IPAM pool.

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

The state message.

", "smithy.api#xmlName": "stateMessage" } }, @@ -65546,6 +66506,13 @@ "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

", "smithy.api#xmlName": "publicIpSource" } + }, + "SourceResource": { + "target": "com.amazonaws.ec2#IpamPoolSourceResource", + "traits": { + "aws.protocols#ec2QueryName": "SourceResource", + "smithy.api#xmlName": "sourceResource" + } } }, "traits": { @@ -65616,6 +66583,15 @@ "smithy.api#documentation": "

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

" } }, + "com.amazonaws.ec2#IpamPoolAllocationAllowedCidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs": { "type": "list", "member": { @@ -65654,6 +66630,12 @@ "traits": { "smithy.api#enumValue": "custom" } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } } } }, @@ -65860,6 +66842,89 @@ } } }, + "com.amazonaws.ec2#IpamPoolSourceResource": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The source resource ID.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamPoolSourceResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The source resource type.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The source resource Region.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwner", + "smithy.api#documentation": "

The source resource owner.

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

The resource used to provision CIDRs to a resource planning pool.

" + } + }, + "com.amazonaws.ec2#IpamPoolSourceResourceRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source resource ID.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamPoolSourceResourceType", + "traits": { + "smithy.api#documentation": "

The source resource type.

" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source resource Region.

" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source resource owner.

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

The resource used to provision CIDRs to a resource planning pool.

" + } + }, + "com.amazonaws.ec2#IpamPoolSourceResourceType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + } + } + }, "com.amazonaws.ec2#IpamPoolState": { "type": "enum", "members": { @@ -65937,6 +67002,199 @@ } } }, + "com.amazonaws.ec2#IpamPublicAddressAssociationStatus": { + "type": "enum", + "members": { + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "DISASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressAwsService": { + "type": "enum", + "members": { + "NAT_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nat-gateway" + } + }, + "DMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "database-migration-service" + } + }, + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "redshift" + } + }, + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elastic-container-service" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "relational-database-service" + } + }, + "S2S_VPN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "site-to-site-vpn" + } + }, + "EC2_LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "load-balancer" + } + }, + "AGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "global-accelerator" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressSecurityGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The security group's name.

", + "smithy.api#xmlName": "groupName" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The security group's ID.

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

The security group that the resource with the public IP address is in.

" + } + }, + "com.amazonaws.ec2#IpamPublicAddressSecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPublicAddressSecurityGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The tag's key.

", + "smithy.api#xmlName": "key" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The tag's value.

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

A tag for a public IP address discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#IpamPublicAddressTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPublicAddressTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPublicAddressTags": { + "type": "structure", + "members": { + "EipTags": { + "target": "com.amazonaws.ec2#IpamPublicAddressTagList", + "traits": { + "aws.protocols#ec2QueryName": "EipTagSet", + "smithy.api#documentation": "

Tags for an Elastic IP address.

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

Tags for a public IP address discovered by IPAM.

" + } + }, + "com.amazonaws.ec2#IpamPublicAddressType": { + "type": "enum", + "members": { + "SERVICE_MANAGED_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-managed-ip" + } + }, + "SERVICE_MANAGED_BYOIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-managed-byoip" + } + }, + "AMAZON_OWNED_EIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-owned-eip" + } + }, + "BYOIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "byoip" + } + }, + "EC2_PUBLIC_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2-public-ip" + } + } + } + }, "com.amazonaws.ec2#IpamResourceCidr": { "type": "structure", "members": { @@ -66475,6 +67733,12 @@ "traits": { "smithy.api#enumValue": "ipv6-pool" } + }, + "eni": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eni" + } } } }, @@ -66766,6 +68030,23 @@ } } }, + "com.amazonaws.ec2#IpamTier": { + "type": "enum", + "members": { + "free": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "free" + } + }, + "advanced": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "advanced" + } + } + } + }, "com.amazonaws.ec2#Ipv4PoolCoipId": { "type": "string" }, @@ -68678,6 +69959,14 @@ "smithy.api#documentation": "

Contains the ENA Express settings for instances launched from your launch template.

", "smithy.api#xmlName": "enaSrdSpecification" } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecification", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionTrackingSpecification", + "smithy.api#documentation": "

A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "connectionTrackingSpecification" + } } }, "traits": { @@ -68824,6 +70113,12 @@ "traits": { "smithy.api#documentation": "

Configure ENA Express settings for your launch template.

" } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

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

The operating Regions to remove.

", "smithy.api#xmlName": "RemoveOperatingRegion" } + }, + "Tier": { + "target": "com.amazonaws.ec2#IpamTier", + "traits": { + "smithy.api#documentation": "

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

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

If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use\n this option if the instance that this ENI will be attached to relies on its IPv6 address\n not changing. Amazon Web Services will automatically assign an IPv6 address associated\n with the ENI attached to your instance to be the primary IPv6 address. Once you enable\n an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.

" } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A connection tracking specification.

" + } } }, "traits": { @@ -78176,6 +79483,14 @@ "smithy.api#xmlName": "availabilityZone" } }, + "ConnectionTrackingConfiguration": { + "target": "com.amazonaws.ec2#ConnectionTrackingConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionTrackingConfiguration", + "smithy.api#documentation": "

A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "connectionTrackingConfiguration" + } + }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -81732,6 +83047,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#ProvisionIpamByoasn": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionIpamByoasnRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionIpamByoasnResult" + }, + "traits": { + "smithy.api#documentation": "

Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

" + } + }, + "com.amazonaws.ec2#ProvisionIpamByoasnRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An IPAM ID.

", + "smithy.api#required": {} + } + }, + "Asn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A public 2-byte or 4-byte ASN.

", + "smithy.api#required": {} + } + }, + "AsnAuthorizationContext": { + "target": "com.amazonaws.ec2#AsnAuthorizationContext", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An ASN authorization context.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionIpamByoasnResult": { + "type": "structure", + "members": { + "Byoasn": { + "target": "com.amazonaws.ec2#Byoasn", + "traits": { + "aws.protocols#ec2QueryName": "Byoasn", + "smithy.api#documentation": "

An ASN and BYOIP CIDR association.

", + "smithy.api#xmlName": "byoasn" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#ProvisionIpamPoolCidr": { "type": "operation", "input": { @@ -99187,7 +100568,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Information about an association between a branch network interface with a trunk network interface.

" + "smithy.api#documentation": "

Information about an association between a branch network interface with a trunk network interface.

" } }, "com.amazonaws.ec2#TrunkInterfaceAssociationId": { diff --git a/codegen/sdk-codegen/aws-models/ecr.json b/codegen/sdk-codegen/aws-models/ecr.json index 1b4e7d1c0a2..79a2193878e 100644 --- a/codegen/sdk-codegen/aws-models/ecr.json +++ b/codegen/sdk-codegen/aws-models/ecr.json @@ -153,8 +153,14 @@ { "target": "com.amazonaws.ecr#UntagResource" }, + { + "target": "com.amazonaws.ecr#UpdatePullThroughCacheRule" + }, { "target": "com.amazonaws.ecr#UploadLayerPart" + }, + { + "target": "com.amazonaws.ecr#ValidatePullThroughCacheRule" } ], "traits": { @@ -216,7 +222,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -259,7 +264,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -272,7 +278,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -286,7 +291,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -309,7 +313,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -344,7 +347,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -355,14 +357,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -376,14 +380,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -392,18 +394,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws", { "fn": "getAttr", "argv": [ @@ -412,7 +413,8 @@ }, "name" ] - } + }, + "aws" ] } ], @@ -428,7 +430,6 @@ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -437,7 +438,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -457,14 +459,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -478,7 +482,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -498,7 +501,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -509,14 +511,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -527,9 +531,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1556,11 +1562,17 @@ { "target": "com.amazonaws.ecr#InvalidParameterException" }, + { + "target": "com.amazonaws.ecr#LimitExceededException" + }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnableToGetUpstreamImageException" } ], "traits": { @@ -1857,9 +1869,18 @@ { "target": "com.amazonaws.ecr#PullThroughCacheRuleAlreadyExistsException" }, + { + "target": "com.amazonaws.ecr#SecretNotFoundException" + }, { "target": "com.amazonaws.ecr#ServerException" }, + { + "target": "com.amazonaws.ecr#UnableToAccessSecretException" + }, + { + "target": "com.amazonaws.ecr#UnableToDecryptSecretValueException" + }, { "target": "com.amazonaws.ecr#UnsupportedUpstreamRegistryException" }, @@ -1868,7 +1889,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a pull through cache rule. A pull through cache rule provides a way to cache\n images from an external public registry in your Amazon ECR private registry.

" + "smithy.api#documentation": "

Creates a pull through cache rule. A pull through cache rule provides a way to cache\n images from an upstream registry source in your Amazon ECR private registry. For more\n information, see Using pull through cache\n rules in the Amazon Elastic Container Registry User Guide.

" } }, "com.amazonaws.ecr#CreatePullThroughCacheRuleRequest": { @@ -1884,7 +1905,7 @@ "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { - "smithy.api#documentation": "

The registry URL of the upstream public registry to use as the source for the pull\n through cache rule.

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

The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.

\n ", "smithy.api#required": {} } }, @@ -1893,6 +1914,18 @@ "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry to create the pull through cache\n rule for. If you do not specify a registry, the default registry is assumed.

" } + }, + "upstreamRegistry": { + "target": "com.amazonaws.ecr#UpstreamRegistry", + "traits": { + "smithy.api#documentation": "

The name of the upstream registry.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate\n to the upstream registry.

" + } } }, "traits": { @@ -1925,6 +1958,18 @@ "traits": { "smithy.api#documentation": "

The registry ID associated with the request.

" } + }, + "upstreamRegistry": { + "target": "com.amazonaws.ecr#UpstreamRegistry", + "traits": { + "smithy.api#documentation": "

The name of the upstream registry associated with the pull through cache rule.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

" + } } }, "traits": { @@ -2044,6 +2089,16 @@ "com.amazonaws.ecr#CreationTimestamp": { "type": "timestamp" }, + "com.amazonaws.ecr#CredentialArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 612 + }, + "smithy.api#pattern": "^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$" + } + }, "com.amazonaws.ecr#CvssScore": { "type": "structure", "members": { @@ -2306,6 +2361,12 @@ "traits": { "smithy.api#documentation": "

The registry ID associated with the request.

" } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

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

Deletes a repository. If the repository contains images, you must either delete all\n images in the repository or use the force option to delete the\n repository.

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

Deletes a repository. If the repository isn't empty, you must either delete the\n contents of the repository or use the force option to delete the repository\n and have Amazon ECR delete all of its contents on your behalf.

", "smithy.api#examples": [ { "title": "To force delete a repository", @@ -2518,7 +2579,7 @@ "target": "com.amazonaws.ecr#ForceFlag", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If a repository contains images, forces the deletion.

" + "smithy.api#documentation": "

If true, deleting the repository force deletes the contents of the repository. If\n false, the repository must be empty before attempting to delete it.

" } } }, @@ -3434,6 +3495,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnableToGetUpstreamLayerException" } ], "traits": { @@ -4155,6 +4219,24 @@ "traits": { "smithy.api#enumValue": "KmsError" } + }, + "UpstreamAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpstreamAccessDenied" + } + }, + "UpstreamTooManyRequests": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpstreamTooManyRequests" + } + }, + "UpstreamUnavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpstreamUnavailable" + } } } }, @@ -4608,6 +4690,12 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ecr#IsPTCRuleValid": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.ecr#KmsError": { "type": "string" }, @@ -5228,6 +5316,9 @@ "com.amazonaws.ecr#NextToken": { "type": "string" }, + "com.amazonaws.ecr#PTCValidateFailure": { + "type": "string" + }, "com.amazonaws.ecr#PackageManager": { "type": "string" }, @@ -5339,6 +5430,24 @@ "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry the pull through cache rule is\n associated with.

" } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret associated with the pull through cache rule.

" + } + }, + "upstreamRegistry": { + "target": "com.amazonaws.ecr#UpstreamRegistry", + "traits": { + "smithy.api#documentation": "

The name of the upstream source registry associated with the pull through cache\n rule.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecr#UpdatedTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the pull through cache rule was\n last updated.

" + } } }, "traits": { @@ -5380,9 +5489,9 @@ "traits": { "smithy.api#length": { "min": 2, - "max": 20 + "max": 30 }, - "smithy.api#pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$" + "smithy.api#pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$" } }, "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefixList": { @@ -6738,6 +6847,18 @@ "com.amazonaws.ecr#ScoringVector": { "type": "string" }, + "com.amazonaws.ecr#SecretNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The ARN of the secret specified in the pull through cache rule was not found. Update\n the pull through cache rule with a valid secret ARN and try again.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.ecr#ServerException": { "type": "structure", "members": { @@ -7187,6 +7308,54 @@ "com.amazonaws.ecr#Type": { "type": "string" }, + "com.amazonaws.ecr#UnableToAccessSecretException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The secret is unable to be accessed. Verify the resource permissions for the secret\n and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnableToDecryptSecretValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The secret is accessible but is unable to be decrypted. Verify the resource\n permisisons and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnableToGetUpstreamImageException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The image or images were unable to be pulled using the pull through cache rule. This\n is usually caused because of an issue with the Secrets Manager secret containing the credentials\n for the upstream registry.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#UnableToGetUpstreamLayerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was an issue getting the upstream layer matching the pull through cache\n rule.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.ecr#UnsupportedImageTypeException": { "type": "structure", "members": { @@ -7269,6 +7438,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.ecr#UpdatePullThroughCacheRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#UpdatePullThroughCacheRuleRequest" + }, + "output": { + "target": "com.amazonaws.ecr#UpdatePullThroughCacheRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" + }, + { + "target": "com.amazonaws.ecr#SecretNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#UnableToAccessSecretException" + }, + { + "target": "com.amazonaws.ecr#UnableToDecryptSecretValueException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing pull through cache rule.

" + } + }, + "com.amazonaws.ecr#UpdatePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the registry associated with the pull through\n cache rule. If you do not specify a registry, the default registry is assumed.

" + } + }, + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The repository name prefix to use when caching images from the source registry.

", + "smithy.api#required": {} + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate\n to the upstream registry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#UpdatePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the pull through cache rule.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecr#UpdatedTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the pull through cache rule was\n updated.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecr#UpdatedTimestamp": { + "type": "timestamp" + }, "com.amazonaws.ecr#UploadId": { "type": "string", "traits": { @@ -7406,9 +7673,142 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ecr#UpstreamRegistry": { + "type": "enum", + "members": { + "EcrPublic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ecr-public" + } + }, + "Quay": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "quay" + } + }, + "K8s": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k8s" + } + }, + "DockerHub": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "docker-hub" + } + }, + "GitHubContainerRegistry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "github-container-registry" + } + }, + "AzureContainerRegistry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "azure-container-registry" + } + } + } + }, "com.amazonaws.ecr#Url": { "type": "string" }, + "com.amazonaws.ecr#ValidatePullThroughCacheRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#ValidatePullThroughCacheRuleRequest" + }, + "output": { + "target": "com.amazonaws.ecr#ValidatePullThroughCacheRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Validates an existing pull through cache rule for an upstream registry that requires\n authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the\n syntax, and then validate that authentication to the upstream registry is\n successful.

" + } + }, + "com.amazonaws.ecr#ValidatePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The repository name prefix associated with the pull through cache rule.

", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the pull through cache rule.\n If you do not specify a registry, the default registry is assumed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecr#ValidatePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository prefix associated with the pull through cache rule.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "

The upstream registry URL associated with the pull through cache rule.

" + } + }, + "credentialArn": { + "target": "com.amazonaws.ecr#CredentialArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.

" + } + }, + "isValid": { + "target": "com.amazonaws.ecr#IsPTCRuleValid", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not the pull through cache rule was validated. If true, Amazon ECR\n was able to reach the upstream registry and authentication was successful. If\n false, there was an issue and validation failed. The\n failure reason indicates the cause.

" + } + }, + "failure": { + "target": "com.amazonaws.ecr#PTCValidateFailure", + "traits": { + "smithy.api#documentation": "

The reason the validation failed. For more details about possible causes and how to\n address them, see Using pull through cache\n rules in the Amazon Elastic Container Registry User Guide.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ecr#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/emr.json b/codegen/sdk-codegen/aws-models/emr.json index 5bb86f6c459..5bee252ef4c 100644 --- a/codegen/sdk-codegen/aws-models/emr.json +++ b/codegen/sdk-codegen/aws-models/emr.json @@ -75,7 +75,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an instance fleet to a running cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x.

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

Adds an instance fleet to a running cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x.

\n " } }, "com.amazonaws.emr#AddInstanceFleetInput": { @@ -365,7 +365,7 @@ } }, "traits": { - "smithy.api#documentation": "

With Amazon EMR release version 4.0 and higher, the only accepted parameter is\n the application name. To pass arguments to applications, you use configuration\n classifications specified using configuration JSON objects. For more information, see\n Configuring Applications.

\n

With earlier Amazon EMR releases, the application is any Amazon or third-party\n software that you can add to the cluster. This structure contains a list of strings that\n indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation\n script as bootstrap action argument.

" + "smithy.api#documentation": "

With Amazon EMR release version 4.0 and later, the only accepted parameter is\n the application name. To pass arguments to applications, you use configuration\n classifications specified using configuration JSON objects. For more information, see\n Configuring Applications.

\n

With earlier Amazon EMR releases, the application is any Amazon or third-party\n software that you can add to the cluster. This structure contains a list of strings that\n indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation\n script as bootstrap action argument.

" } }, "com.amazonaws.emr#ApplicationList": { @@ -705,7 +705,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and higher, excluding version 5.0.0. A maximum of 256 steps are allowed\n in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not\n guarantee that a step will be canceled, even if the request is successfully submitted. When\n you use Amazon EMR releases 5.28.0 and higher, you can cancel steps that are in a\n PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.

" + "smithy.api#documentation": "

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in\n each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee\n that a step will be canceled, even if the request is successfully submitted. When you use\n Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a\n PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.

" } }, "com.amazonaws.emr#CancelStepsInfo": { @@ -731,7 +731,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and higher, excluding version 5.0.0.

" + "smithy.api#documentation": "

Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.

" } }, "com.amazonaws.emr#CancelStepsInfoList": { @@ -903,7 +903,7 @@ "InstanceCollectionType": { "target": "com.amazonaws.emr#InstanceCollectionType", "traits": { - "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

\n \n

The instance group configuration of the cluster. A value of INSTANCE_GROUP\n indicates a uniform instance group configuration. A value of INSTANCE_FLEET\n indicates an instance fleets configuration.

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

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n \n

The instance group configuration of the cluster. A value of INSTANCE_GROUP\n indicates a uniform instance group configuration. A value of INSTANCE_FLEET\n indicates an instance fleets configuration.

" } }, "LogUri": { @@ -915,7 +915,7 @@ "LogEncryptionKmsKeyId": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is only\n available with Amazon EMR 5.30.0 and higher, excluding Amazon EMR 6.0.0.\n

" + "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is only\n available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.\n

" } }, "RequestedAmiVersion": { @@ -933,7 +933,7 @@ "ReleaseLabel": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source\n application packages installed on the cluster. Release labels are in the form\n emr-x.x.x, where x.x.x is an Amazon EMR release version such as\n emr-5.14.0. For more information about Amazon EMR release versions\n and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR\n releases version 4.0 and higher. Earlier versions use AmiVersion.

" + "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source\n application packages installed on the cluster. Release labels are in the form\n emr-x.x.x, where x.x.x is an Amazon EMR release version such as\n emr-5.14.0. For more information about Amazon EMR release versions\n and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR\n releases version 4.0 and later. Earlier versions use AmiVersion.

" } }, "AutoTerminate": { @@ -987,7 +987,7 @@ "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR releases 4.x and higher. The list of configurations\n that are supplied to the Amazon EMR cluster.

" + "smithy.api#documentation": "

Applies only to Amazon EMR releases 4.x and later. The list of configurations\n that are supplied to the Amazon EMR cluster.

" } }, "SecurityConfiguration": { @@ -1005,19 +1005,19 @@ "ScaleDownBehavior": { "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { - "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n higher and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR releases 4.1.0 and higher, and is the default for versions of Amazon EMR earlier than 5.1.0.

" + "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, "CustomAmiId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Available only in Amazon EMR releases 5.7.0 and higher. The ID of a custom\n Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

" + "smithy.api#documentation": "

Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI if the cluster uses a custom AMI.

" } }, "EbsRootVolumeSize": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume for the Linux AMI that\n each Amazon EC2 instance uses. Available in Amazon EMR releases 4.x and\n higher.

" + "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and\n later.

" } }, "RepoUpgradeOnBoot": { @@ -1065,13 +1065,13 @@ "EbsRootVolumeIops": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The IOPS, of the Amazon EBS root device volume for the Linux AMI that each\n Amazon EC2 instance uses. Available in Amazon EMR releases 6.15.0 and\n higher.

" + "smithy.api#documentation": "

The IOPS, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\n later.

" } }, "EbsRootVolumeThroughput": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The throughput, in MiB/s, of the Amazon EBS root device volume for the Linux AMI\n that each Amazon EC2 instance uses. Available in Amazon EMR releases 6.15.0\n and higher.

" + "smithy.api#documentation": "

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\n later.

" } } }, @@ -1467,7 +1467,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Amazon EMR releases 4.x or higher.

\n \n

An optional configuration specification to be used when provisioning cluster instances,\n which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional\n nested configurations. A classification refers to an application-specific configuration\n file. Properties are the settings you want to change in that file. For more information,\n see Configuring Applications.

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

Amazon EMR releases 4.x or later.

\n \n

An optional configuration specification to be used when provisioning cluster instances,\n which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional\n nested configurations. A classification refers to an application-specific configuration\n file. Properties are the settings you want to change in that file. For more information,\n see Configuring Applications.

" } }, "com.amazonaws.emr#ConfigurationList": { @@ -1660,6 +1660,30 @@ "traits": { "smithy.api#documentation": "

A list of tags to associate with the Amazon EMR Studio. Tags are user-defined\n key-value pairs that consist of a required key string with a maximum of 128 characters, and\n an optional value string with a maximum of 256 characters.

" } + }, + "TrustedIdentityPropagationEnabled": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "

\n A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.\n

" + } + }, + "IdcUserAssignment": { + "target": "com.amazonaws.emr#IdcUserAssignment", + "traits": { + "smithy.api#documentation": "

\n Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.\n

" + } + }, + "IdcInstanceArn": { + "target": "com.amazonaws.emr#ArnType", + "traits": { + "smithy.api#documentation": "

\n The ARN of the IAM Identity Center instance to create the Studio application.\n

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

" + } } }, "traits": { @@ -4051,7 +4075,7 @@ "target": "com.amazonaws.emr#BlockPublicAccessConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges in the\n BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. To change this, update the block public access\n configuration to remove the exception.

\n \n

For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an Amazon EMR cluster\n in a Region before this date, block public access is enabled by default in that\n Region.

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

A configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges in the\n BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating the block public\n access configuration to remove the exception.

\n \n

For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an Amazon EMR cluster\n in a Region before this date, block public access is enabled by default in that\n Region.

\n ", "smithy.api#required": {} } }, @@ -4318,6 +4342,23 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" } }, + "com.amazonaws.emr#IdcUserAssignment": { + "type": "enum", + "members": { + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" + } + }, + "OPTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIONAL" + } + } + } + }, "com.amazonaws.emr#IdentityType": { "type": "enum", "members": { @@ -4503,7 +4544,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an instance fleet, which is a group of Amazon EC2 instances that host\n a particular node type (master, core, or task) in an Amazon EMR cluster. Instance\n fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are\n provisioned to meet a defined target capacity.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

Describes an instance fleet, which is a group of Amazon EC2 instances that host\n a particular node type (master, core, or task) in an Amazon EMR cluster. Instance\n fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are\n provisioned to meet a defined target capacity.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetConfig": { @@ -4555,7 +4596,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration that defines an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

The configuration that defines an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetConfigList": { @@ -4604,7 +4645,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration parameters for an instance fleet modification request.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

Configuration parameters for an instance fleet modification request.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetProvisioningSpecifications": { @@ -4619,12 +4660,12 @@ "OnDemandSpecification": { "target": "com.amazonaws.emr#OnDemandProvisioningSpecification", "traits": { - "smithy.api#documentation": "

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR releases 5.12.1 and higher.

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

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR releases 5.12.1 and later.

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

The launch specification for Spot Instances in the fleet, which determines the defined\n duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions. On-Demand and Spot instance allocation\n strategies are available in Amazon EMR releases 5.12.1 and higher.

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

The launch specification for Spot Instances in the fleet, which determines the defined\n duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation\n strategies are available in Amazon EMR releases 5.12.1 and later.

\n " } }, "com.amazonaws.emr#InstanceFleetResizingSpecifications": { @@ -4711,7 +4752,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides status change reason details for the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

Provides status change reason details for the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetStateChangeReasonCode": { @@ -4766,7 +4807,7 @@ } }, "traits": { - "smithy.api#documentation": "

The status of the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

The status of the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetTimeline": { @@ -4792,7 +4833,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides historical timestamps for the instance fleet, including the time of creation,\n the time it became ready to run jobs, and the time of termination.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

Provides historical timestamps for the instance fleet, including the time of creation,\n the time it became ready to run jobs, and the time of termination.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetType": { @@ -4878,7 +4919,7 @@ "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "\n

Amazon EMR releases 4.x or higher.

\n \n

The list of configurations supplied for an Amazon EMR cluster instance group.\n You can specify a separate configuration for each instance group (master, core, and\n task).

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

Amazon EMR releases 4.x or later.

\n \n

The list of configurations supplied for an Amazon EMR cluster instance group.\n You can specify a separate configuration for each instance group (master, core, and\n task).

" } }, "ConfigurationsVersion": { @@ -4982,7 +5023,7 @@ "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "\n

Amazon EMR releases 4.x or higher.

\n \n

The list of configurations supplied for an Amazon EMR cluster instance group.\n You can specify a separate configuration for each instance group (master, core, and\n task).

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

Amazon EMR releases 4.x or later.

\n \n

The list of configurations supplied for an Amazon EMR cluster instance group.\n You can specify a separate configuration for each instance group (master, core, and\n task).

" } }, "EbsConfiguration": { @@ -5665,7 +5706,7 @@ } }, "traits": { - "smithy.api#documentation": "

An instance type configuration for each instance type in an instance fleet, which\n determines the Amazon EC2 instances Amazon EMR attempts to provision to\n fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can\n include a maximum of 30 instance type configurations for a fleet. For more information\n about how to use an allocation strategy, see Configure Instance\n Fleets. Without an allocation strategy, you may specify a maximum of five\n instance type configurations for a fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

An instance type configuration for each instance type in an instance fleet, which\n determines the Amazon EC2 instances Amazon EMR attempts to provision to\n fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can\n include a maximum of 30 instance type configurations for a fleet. For more information\n about how to use an allocation strategy, see Configure Instance\n Fleets. Without an allocation strategy, you may specify a maximum of five\n instance type configurations for a fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceTypeConfigList": { @@ -5727,7 +5768,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration specification for each instance type in an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

The configuration specification for each instance type in an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceTypeSpecificationList": { @@ -5816,13 +5857,13 @@ "LogEncryptionKmsKeyId": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is only\n available with Amazon EMR 5.30.0 and higher, excluding 6.0.0.

" + "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is only\n available with Amazon EMR 5.30.0 and later, excluding 6.0.0.

" } }, "AmiVersion": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR\n releases 4.0 and higher, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" + "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR\n releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" } }, "ExecutionStatusDetail": { @@ -5886,7 +5927,7 @@ "ScaleDownBehavior": { "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { - "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n higher and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR releases 4.1.0 and higher, and is the default for releases of Amazon EMR earlier than 5.1.0.

" + "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.

" } } }, @@ -6040,7 +6081,7 @@ "InstanceFleets": { "target": "com.amazonaws.emr#InstanceFleetConfigList", "traits": { - "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

\n \n

Describes the Amazon EC2 instances and instance configurations for clusters that\n use the instance fleet configuration.

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

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n \n

Describes the Amazon EC2 instances and instance configurations for clusters that\n use the instance fleet configuration.

" } }, "Ec2KeyName": { @@ -6082,7 +6123,7 @@ "Ec2SubnetIds": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

Applies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches\n instances in the optimal subnet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

Applies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches\n instances in the optimal subnet.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "EmrManagedMasterSecurityGroup": { @@ -6445,7 +6486,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all available details about the instance fleets in a cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

Lists all available details about the instance fleets in a cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -7110,7 +7151,7 @@ } ], "traits": { - "smithy.api#documentation": "

A list of the instance types that Amazon EMR supports. You can filter the list\n by Amazon Web Services Region and Amazon EMR release.

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

A list of the instance types that Amazon EMR supports. You can filter the\n list by Amazon Web Services Region and Amazon EMR release.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker" @@ -7304,7 +7345,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the target On-Demand and target Spot capacities for the instance fleet with the\n specified InstanceFleetID within the cluster specified using ClusterID. The call either\n succeeds or fails atomically.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

Modifies the target On-Demand and target Spot capacities for the instance fleet with the\n specified InstanceFleetID within the cluster specified using ClusterID. The call either\n succeeds or fails atomically.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#ModifyInstanceFleetInput": { @@ -7764,7 +7805,7 @@ } }, "traits": { - "smithy.api#documentation": "

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR releases 5.12.1 and higher.

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

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR releases 5.12.1 and later.

\n " } }, "com.amazonaws.emr#OnDemandResizingSpecification": { @@ -7912,7 +7953,7 @@ "AvailabilityZones": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

When multiple Availability Zones are specified, Amazon EMR evaluates them and\n launches instances in the optimal Availability Zone. AvailabilityZones is used\n for instance fleets, while AvailabilityZone (singular) is used for uniform\n instance groups.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions.

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

When multiple Availability Zones are specified, Amazon EMR evaluates them and\n launches instances in the optimal Availability Zone. AvailabilityZones is used\n for instance fleets, while AvailabilityZone (singular) is used for uniform\n instance groups.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions.

\n " } } }, @@ -8042,7 +8083,7 @@ "target": "com.amazonaws.emr#PutAutoTerminationPolicyOutput" }, "traits": { - "smithy.api#documentation": "\n

Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and\n higher. For more information, see Using an\n auto-termination policy.

\n \n

Creates or updates an auto-termination policy for an Amazon EMR cluster. An\n auto-termination policy defines the amount of idle time in seconds after which a cluster\n automatically terminates. For alternative cluster termination options, see Control\n cluster termination.

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

Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and\n later. For more information, see Using an\n auto-termination policy.

\n \n

Creates or updates an auto-termination policy for an Amazon EMR cluster. An\n auto-termination policy defines the amount of idle time in seconds after which a cluster\n automatically terminates. For alternative cluster termination options, see Control\n cluster termination.

" } }, "com.amazonaws.emr#PutAutoTerminationPolicyInput": { @@ -8397,7 +8438,7 @@ } ], "traits": { - "smithy.api#documentation": "

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the\n steps specified. After the steps complete, the cluster stops and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig\n KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster\n transitions to the WAITING state rather than shutting down after the steps have completed.

\n

For additional protection, you can set the JobFlowInstancesConfig\n TerminationProtected parameter to TRUE to lock the cluster and\n prevent it from being terminated by API call, user intervention, or in the event of a job\n flow error.

\n

A maximum of 256 steps are allowed in each job flow.

\n

If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using the SSH shell to connect to the master node and submitting\n queries directly to the software running on the master node, such as Hive and\n Hadoop.

\n

For long-running clusters, we recommend that you periodically store your results.

\n \n

The instance fleets configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions. The RunJobFlow request can contain\n InstanceFleets parameters or InstanceGroups parameters, but not both.

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

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the\n steps specified. After the steps complete, the cluster stops and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig\n KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster\n transitions to the WAITING state rather than shutting down after the steps have completed.

\n

For additional protection, you can set the JobFlowInstancesConfig\n TerminationProtected parameter to TRUE to lock the cluster and\n prevent it from being terminated by API call, user intervention, or in the event of a job\n flow error.

\n

A maximum of 256 steps are allowed in each job flow.

\n

If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using the SSH shell to connect to the master node and submitting\n queries directly to the software running on the master node, such as Hive and\n Hadoop.

\n

For long-running clusters, we recommend that you periodically store your results.

\n \n

The instance fleets configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain\n InstanceFleets parameters or InstanceGroups parameters, but not both.

\n " } }, "com.amazonaws.emr#RunJobFlowInput": { @@ -8420,7 +8461,7 @@ "LogEncryptionKmsKeyId": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The KMS key used for encrypting log files. If a value is not\n provided, the logs remain encrypted by AES-256. This attribute is only available with\n Amazon EMR releases 5.30.0 and higher, excluding Amazon EMR\n 6.0.0.

" + "smithy.api#documentation": "

The KMS key used for encrypting log files. If a value is not\n provided, the logs remain encrypted by AES-256. This attribute is only available with\n Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.

" } }, "AdditionalInfo": { @@ -8432,13 +8473,13 @@ "AmiVersion": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR\n releases 4.0 and higher, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" + "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR\n releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" } }, "ReleaseLabel": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source\n application packages installed on the cluster. Release labels are in the form\n emr-x.x.x, where x.x.x is an Amazon EMR release version such as\n emr-5.14.0. For more information about Amazon EMR release versions\n and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR\n releases version 4.0 and higher. Earlier versions use AmiVersion.

" + "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source\n application packages installed on the cluster. Release labels are in the form\n emr-x.x.x, where x.x.x is an Amazon EMR release version such as\n emr-5.14.0. For more information about Amazon EMR release versions\n and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR\n releases version 4.0 and later. Earlier versions use AmiVersion.

" } }, "Instances": { @@ -8464,25 +8505,25 @@ "SupportedProducts": { "target": "com.amazonaws.emr#SupportedProductsList", "traits": { - "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n higher, use Applications.

\n \n

A list of strings that indicates third-party software to use. For more information, see\n the Amazon EMR Developer Guide. Currently supported values are:

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

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n later, use Applications.

\n \n

A list of strings that indicates third-party software to use. For more information, see\n the Amazon EMR Developer Guide. Currently supported values are:

\n " } }, "NewSupportedProducts": { "target": "com.amazonaws.emr#NewSupportedProductsList", "traits": { - "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n higher, use Applications.

\n \n

A list of strings that indicates third-party software to use with the job flow that\n accepts a user argument list. Amazon EMR accepts and forwards the argument list to\n the corresponding installation script as bootstrap action arguments. For more information,\n see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR\n Developer Guide. Supported values are:

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

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n later, use Applications.

\n \n

A list of strings that indicates third-party software to use with the job flow that\n accepts a user argument list. Amazon EMR accepts and forwards the argument list to\n the corresponding installation script as bootstrap action arguments. For more information,\n see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR\n Developer Guide. Supported values are:

\n " } }, "Applications": { "target": "com.amazonaws.emr#ApplicationList", "traits": { - "smithy.api#documentation": "

Applies to Amazon EMR releases 4.0 and higher. A case-insensitive list of\n applications for Amazon EMR to install and configure when launching the cluster.\n For a list of applications available for each Amazon EMR release version, see the\n Amazon EMRRelease\n Guide.

" + "smithy.api#documentation": "

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of\n applications for Amazon EMR to install and configure when launching the cluster.\n For a list of applications available for each Amazon EMR release version, see the\n Amazon EMRRelease\n Guide.

" } }, "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "

For Amazon EMR releases 4.0 and higher. The list of configurations supplied for\n the Amazon EMR cluster that you are creating.

" + "smithy.api#documentation": "

For Amazon EMR releases 4.0 and later. The list of configurations supplied for\n the Amazon EMR cluster that you are creating.

" } }, "VisibleToAllUsers": { @@ -8524,19 +8565,19 @@ "ScaleDownBehavior": { "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { - "smithy.api#documentation": "

Specifies the way that individual Amazon EC2 instances terminate when an\n automatic scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n higher and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR releases 4.1.0 and higher, and is the default for releases of Amazon EMR earlier than 5.1.0.

" + "smithy.api#documentation": "

Specifies the way that individual Amazon EC2 instances terminate when an\n automatic scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.

" } }, "CustomAmiId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Available only in Amazon EMR releases 5.7.0 and higher. The ID of a custom\n Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it\n launches cluster Amazon EC2 instances. For more information about custom AMIs in\n Amazon EMR, see Using a Custom AMI in the\n Amazon EMR Management Guide. If omitted, the cluster\n uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR\n releases 2.x and 3.x, use AmiVersion instead.

\n

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances. For information about finding an AMI ID, see Finding a Linux\n AMI.

" + "smithy.api#documentation": "

Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches\n cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the\n Amazon EMR Management Guide. If omitted, the cluster\n uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR\n releases 2.x and 3.x, use AmiVersion instead.

\n

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances. For information about finding an AMI ID, see Finding a Linux\n AMI.

" } }, "EbsRootVolumeSize": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume for the Linux AMI that\n each Amazon EC2 instance uses. Available in Amazon EMR releases 4.x and\n higher.

" + "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and\n later.

" } }, "RepoUpgradeOnBoot": { @@ -8581,18 +8622,18 @@ "EbsRootVolumeIops": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The IOPS for the Amazon EBS root device volume for the Linux AMI that each\n Amazon EC2 instance uses. Available in Amazon EMR releases 6.15.0 and\n higher.

" + "smithy.api#documentation": "

The IOPS, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\n later.

" } }, "EbsRootVolumeThroughput": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The throughput, in MiB/s, of the Amazon EBS root device volume for the Linux AMI\n that each Amazon EC2 instance uses. Available in Amazon EMR releases 6.15.0\n and higher.

" + "smithy.api#documentation": "

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\n later.

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

Input to the RunJobFlow operation.

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

Input to the RunJobFlow operation.

", "smithy.api#input": {} } }, @@ -9109,12 +9150,12 @@ "AllocationStrategy": { "target": "com.amazonaws.emr#SpotProvisioningAllocationStrategy", "traits": { - "smithy.api#documentation": "

Specifies one of the following strategies to launch Spot Instance fleets:\n price-capacity-optimized, capacity-optimized,\n lowest-price, or diversified. For more information on the\n provisioning strategies, see Allocation strategies\n for Spot Instances in the Amazon EC2 User Guide for Linux\n Instances.

\n \n

When you launch a Spot Instance fleet with the old console, it automatically launches\n with the capacity-optimized strategy. You can't change the allocation\n strategy from the old console.

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

Specifies one of the following strategies to launch Spot Instance fleets: price-capacity-optimized, capacity-optimized, lowest-price, or diversified. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.

\n \n

When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized strategy. You can't change the allocation strategy from the old console.

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

The launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and higher, excluding 5.0.x versions. Spot Instance allocation strategy is\n available in Amazon EMR releases 5.12.1 and higher.

\n \n \n

Spot Instances with a defined duration (also known as Spot blocks) are no longer\n available to new customers from July 1, 2021. For customers who have previously used the\n feature, we will continue to support Spot Instances with a defined duration until\n December 31, 2022.

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

The launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR releases\n 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is\n available in Amazon EMR releases 5.12.1 and later.

\n \n \n

Spot Instances with a defined duration (also known as Spot blocks) are no longer\n available to new customers from July 1, 2021. For customers who have previously used the\n feature, we will continue to support Spot Instances with a defined duration until\n December 31, 2022.

\n " } }, "com.amazonaws.emr#SpotProvisioningTimeoutAction": { @@ -9872,6 +9913,30 @@ "traits": { "smithy.api#documentation": "

A list of tags associated with the Amazon EMR Studio.

" } + }, + "IdcInstanceArn": { + "target": "com.amazonaws.emr#ArnType", + "traits": { + "smithy.api#documentation": "

\n The ARN of the IAM Identity Center instance the Studio application belongs to.\n

" + } + }, + "TrustedIdentityPropagationEnabled": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the Studio has Trusted identity propagation enabled. The default value is false.\n

" + } + }, + "IdcUserAssignment": { + "target": "com.amazonaws.emr#IdcUserAssignment", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.\n

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

" + } } }, "traits": { @@ -9925,7 +9990,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The\n details do not include subnets, IAM roles, security groups, or tags\n associated with the Studio.

" + "smithy.api#documentation": "

Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. To fetch additional details such as subnets, IAM roles, \n security groups, and tags for the Studio, use the DescribeStudio API.

" } }, "com.amazonaws.emr#StudioSummaryList": { @@ -9952,7 +10017,7 @@ "MemoryGB": { "target": "com.amazonaws.emr#Float", "traits": { - "smithy.api#documentation": "

The amount of memory that is available to Amazon EMR from the\n SupportedInstanceType. The kernel and hypervisor software consume some\n memory, so this value might be lower than the overall memory for the instance type.

" + "smithy.api#documentation": "

The amount of memory that is available to Amazon EMR from the SupportedInstanceType. The kernel and hypervisor\n software consume some memory, so this value might be lower than the overall memory for the\n instance type.

" } }, "StorageGB": { @@ -10335,6 +10400,12 @@ "traits": { "smithy.api#documentation": "

The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.

" } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/eventbridge.json b/codegen/sdk-codegen/aws-models/eventbridge.json index b23a7bf7a40..15d4bd01632 100644 --- a/codegen/sdk-codegen/aws-models/eventbridge.json +++ b/codegen/sdk-codegen/aws-models/eventbridge.json @@ -283,7 +283,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -297,7 +296,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -311,7 +309,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -355,7 +352,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -375,7 +371,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -396,14 +391,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -424,21 +421,24 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: FIPS is not supported with EventBridge multi-region endpoints.", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "EndpointId must be a valid host label.", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -451,7 +451,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -494,7 +493,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -507,7 +507,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -521,7 +520,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -544,7 +542,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -579,7 +576,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -590,14 +586,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -611,14 +609,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -627,11 +623,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -680,14 +676,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -701,7 +699,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -721,7 +718,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -732,14 +728,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -750,9 +748,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2763,7 +2763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an API destination, which is an HTTP invocation endpoint configured as a target\n for events.

" + "smithy.api#documentation": "

Creates an API destination, which is an HTTP invocation endpoint configured as a target\n for events.

\n

API destinations do not support private destinations, such as interface VPC endpoints.

\n

For more information, see API destinations in the EventBridge User Guide.

" } }, "com.amazonaws.eventbridge#CreateApiDestinationRequest": { @@ -3395,7 +3395,7 @@ } ], "traits": { - "smithy.api#documentation": "

Called by an SaaS partner to create a partner event source. This operation is not used by\n Amazon Web Services customers.

\n

Each partner event source can be used by one Amazon Web Services account to create a matching partner\n event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each\n Amazon Web Services account that wants to receive those event types.

\n

A partner event source creates events based on resources within the SaaS partner's service\n or application.

\n

An Amazon Web Services account that creates a partner event bus that matches the partner event source can\n use that event bus to receive events from the partner, and then process them using Amazon Web Services Events\n rules and targets.

\n

Partner event source names follow this format:

\n

\n \n partner_name/event_namespace/event_name\n \n

\n

\n partner_name is determined during partner registration and identifies\n the partner to Amazon Web Services customers. event_namespace is determined by the\n partner and is a way for the partner to categorize their events.\n event_name is determined by the partner, and should uniquely identify\n an event-generating resource within the partner system. The combination of\n event_namespace and event_name should help Amazon Web Services\n customers decide whether to create an event bus to receive these events.

" + "smithy.api#documentation": "

Called by an SaaS partner to create a partner event source. This operation is not used by\n Amazon Web Services customers.

\n

Each partner event source can be used by one Amazon Web Services account to create a matching partner\n event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each\n Amazon Web Services account that wants to receive those event types.

\n

A partner event source creates events based on resources within the SaaS partner's service\n or application.

\n

An Amazon Web Services account that creates a partner event bus that matches the partner event source can\n use that event bus to receive events from the partner, and then process them using Amazon Web Services Events\n rules and targets.

\n

Partner event source names follow this format:

\n

\n \n partner_name/event_namespace/event_name\n \n

\n \n

The combination of\n event_namespace and event_name should help Amazon Web Services\n customers decide whether to create an event bus to receive these events.

" } }, "com.amazonaws.eventbridge#CreatePartnerEventSourceRequest": { @@ -3783,7 +3783,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.eventbridge#DeleteEndpointRequest": { @@ -4285,7 +4285,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

" + "smithy.api#documentation": "

Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.eventbridge#DescribeEndpointRequest": { @@ -4769,7 +4769,7 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "

The event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "ScheduleExpression": { @@ -5091,7 +5091,7 @@ } }, "traits": { - "smithy.api#documentation": "

A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.eventbridge#EndpointArn": { @@ -5931,7 +5931,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

" + "smithy.api#documentation": "

List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.eventbridge#ListEndpointsRequest": { @@ -6344,7 +6344,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the rules for the specified target. You can see which of the rules in Amazon\n EventBridge can invoke a specific target in your account.

" + "smithy.api#documentation": "

Lists the rules for the specified target. You can see which of the rules in Amazon\n EventBridge can invoke a specific target in your account.

\n

The maximum number of results per page for requests is 100.

" } }, "com.amazonaws.eventbridge#ListRuleNamesByTargetRequest": { @@ -6417,7 +6417,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.

\n

ListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.

" + "smithy.api#documentation": "

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.

\n

The maximum number of results per page for requests is 100.

\n

ListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.

" } }, "com.amazonaws.eventbridge#ListRulesRequest": { @@ -6538,7 +6538,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the targets assigned to the specified rule.

" + "smithy.api#documentation": "

Lists the targets assigned to the specified rule.

\n

The maximum number of results per page for requests is 100.

" } }, "com.amazonaws.eventbridge#ListTargetsByRuleRequest": { @@ -6983,7 +6983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends custom events to Amazon EventBridge so that they can be matched to rules.

\n \n

PutEvents will only process nested JSON up to 1100 levels deep.

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

Sends custom events to Amazon EventBridge so that they can be matched to rules.

\n

The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. \n To learn more, see\n Calculating PutEvents event entry size in the Amazon EventBridge User Guide\n

\n

PutEvents accepts the data in JSON format. For the JSON number\n (integer) data type, the constraints are: a minimum value of\n -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.

\n \n

PutEvents will only process nested JSON up to 1100 levels deep.

\n " } }, "com.amazonaws.eventbridge#PutEventsRequest": { @@ -7022,7 +7022,7 @@ "Source": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The source of the event.

" + "smithy.api#documentation": "

The source of the event.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " } }, "Resources": { @@ -7034,19 +7034,19 @@ "DetailType": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

" + "smithy.api#documentation": "

Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " } }, "Detail": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

A valid JSON object. There is no other schema imposed. The JSON object may contain fields\n and nested subobjects.

" + "smithy.api#documentation": "

A valid JSON object. There is no other schema imposed. The JSON object may contain fields\n and nested sub-objects.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " } }, "EventBusName": { "target": "com.amazonaws.eventbridge#NonPartnerEventBusNameOrArn", "traits": { - "smithy.api#documentation": "

The name or ARN of the event bus to receive the event. Only the rules that are associated\n with this event bus are used to match the event. If you omit this, the default event bus is\n used.

\n \n

If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in either \n the primary or secondary Region here and the corresponding event bus in the \n other Region will be determined based on the endpoint referenced by the EndpointId.

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

The name or ARN of the event bus to receive the event. Only the rules that are associated\n with this event bus are used to match the event. If you omit this, the default event bus is\n used.

\n \n

If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus \n in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the \n other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.

\n " } }, "TraceHeader": { @@ -7105,7 +7105,7 @@ "ErrorCode": { "target": "com.amazonaws.eventbridge#ErrorCode", "traits": { - "smithy.api#documentation": "

The error code that indicates why the event submission failed.

" + "smithy.api#documentation": "

The error code that indicates why the event submission failed.

\n

Retryable errors include:

\n \n

Non-retryable errors include:

\n " } }, "ErrorMessage": { @@ -7116,7 +7116,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an event that failed to be submitted. For information about the errors that are common to all actions, see \n Common Errors.

" + "smithy.api#documentation": "

Represents the results of an event submitted to an event bus.

\n

If the submission was successful, the entry has the event ID in it. \n Otherwise, you can use the error code and error message to identify the problem with the entry.

\n

For information about the errors that are common to all actions, see \n Common Errors.

" } }, "com.amazonaws.eventbridge#PutEventsResultEntryList": { @@ -7142,7 +7142,7 @@ } ], "traits": { - "smithy.api#documentation": "

This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services\n customers do not use this operation.

" + "smithy.api#documentation": "

This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services\n customers do not use this operation.

\n

For information on calculating event batch size, see \n Calculating EventBridge PutEvents event entry size\n in the EventBridge User Guide.

" } }, "com.amazonaws.eventbridge#PutPartnerEventsRequest": { @@ -7172,7 +7172,7 @@ "Source": { "target": "com.amazonaws.eventbridge#EventSourceName", "traits": { - "smithy.api#documentation": "

The event source that is generating the entry.

" + "smithy.api#documentation": "

The event source that is generating the entry.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " } }, "Resources": { @@ -7184,13 +7184,13 @@ "DetailType": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

" + "smithy.api#documentation": "

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " } }, "Detail": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. The JSON string may contain fields\n and nested subobjects.

" + "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. The JSON string may contain fields\n and nested sub-objects.

\n \n

\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n

\n " } } }, @@ -7223,7 +7223,7 @@ "Entries": { "target": "com.amazonaws.eventbridge#PutPartnerEventsResultEntryList", "traits": { - "smithy.api#documentation": "

The list of events from this operation that were successfully written to the partner event\n bus.

" + "smithy.api#documentation": "

The results for each event entry the partner submitted in this request. \n If the event was successfully submitted, the entry has the event ID in it. \n Otherwise, you can use the error code and error message to identify the problem with the entry.

\n

For each record, the index of the response element is the same as the index in the request array.

" } } }, @@ -7254,7 +7254,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an event that a partner tried to generate, but failed.

" + "smithy.api#documentation": "

The result of an event entry the partner submitted in this request. \n If the event was successfully submitted, the entry has the event ID in it. \n Otherwise, you can use the error code and error message to identify the problem with the entry.

" } }, "com.amazonaws.eventbridge#PutPartnerEventsResultEntryList": { @@ -7387,13 +7387,13 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "

The event pattern. For more information, see Amazon EventBridge event\n patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The event pattern. For more information, see Amazon EventBridge event\n patterns in the Amazon EventBridge User Guide.

" } }, "State": { "target": "com.amazonaws.eventbridge#RuleState", "traits": { - "smithy.api#documentation": "

Indicates whether the rule is enabled or disabled.

" + "smithy.api#documentation": "

The state of the rule.

\n

Valid values include:

\n " } }, "Description": { @@ -7465,7 +7465,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n \n

Each rule can have up to five (5) targets associated with it at one time.

\n \n

You can configure the following as targets for Events:

\n \n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n \n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n

For more information about enabling cross-account events, see PutPermission.

\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n \n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

The maximum number of entries per request is 10.

\n \n

Each rule can have up to five (5) targets associated with it at one time.

\n \n

For a list of services you can configure as targets for events, see EventBridge targets\n in the Amazon EventBridge User Guide.

\n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are:

\n \n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions: \n

\n \n

For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n \n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n \n

If you have an IAM role on a cross-account event bus target, \n a PutTargets call without a role on the same target (same Id and Arn) will not remove the role.

\n \n

For more information about enabling cross-account events, see PutPermission.

\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n \n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" } }, "com.amazonaws.eventbridge#PutTargetsRequest": { @@ -7608,7 +7608,7 @@ "DbUser": { "target": "com.amazonaws.eventbridge#DbUser", "traits": { - "smithy.api#documentation": "

The database user name. Required when authenticating using temporary credentials.

\n

Do not provide this parameter when connecting to a Redshift Serverless workgroup.

" + "smithy.api#documentation": "

The database user name. Required when authenticating using temporary credentials.

" } }, "Sql": { @@ -7631,11 +7631,14 @@ } }, "Sqls": { - "target": "com.amazonaws.eventbridge#Sqls" + "target": "com.amazonaws.eventbridge#Sqls", + "traits": { + "smithy.api#documentation": "

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. \n Subsequent SQL statements don't start until the previous statement in the array completes. \n If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

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

These are custom parameters to be used when the target is a Amazon Redshift cluster or Redshift Serverless workgroup to invoke the\n Amazon Redshift Data API ExecuteStatement based on EventBridge events.

" + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement based on EventBridge events.

" } }, "com.amazonaws.eventbridge#RedshiftSecretManagerArn": { @@ -7734,7 +7737,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified targets from the specified rule. When the rule is triggered, those\n targets are no longer be invoked.

\n \n

A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

\n \n

When you remove a target, when the associated rule triggers, removed targets might\n continue to be invoked. Allow a short period of time for changes to take effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Removes the specified targets from the specified rule. When the rule is triggered, those\n targets are no longer be invoked.

\n \n

A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

\n \n

When you remove a target, when the associated rule triggers, removed targets might\n continue to be invoked. Allow a short period of time for changes to take effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

\n

The maximum number of entries per request is 10.

" } }, "com.amazonaws.eventbridge#RemoveTargetsRequest": { @@ -8145,13 +8148,13 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "

The event pattern of the rule. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The event pattern of the rule. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "State": { "target": "com.amazonaws.eventbridge#RuleState", "traits": { - "smithy.api#documentation": "

The state of the rule.

" + "smithy.api#documentation": "

The state of the rule.

\n

Valid values include:

\n " } }, "Description": { @@ -8243,6 +8246,12 @@ "traits": { "smithy.api#enumValue": "DISABLED" } + }, + "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS" + } } } }, @@ -8920,7 +8929,7 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "

The event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

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

The event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, @@ -9480,7 +9489,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

" + "smithy.api#documentation": "

Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.eventbridge#UpdateEndpointRequest": { diff --git a/codegen/sdk-codegen/aws-models/internetmonitor.json b/codegen/sdk-codegen/aws-models/internetmonitor.json index 34a7687598c..5aa553ca542 100644 --- a/codegen/sdk-codegen/aws-models/internetmonitor.json +++ b/codegen/sdk-codegen/aws-models/internetmonitor.json @@ -149,7 +149,6 @@ "MaxCityNetworksToMonitor": { "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. Setting this limit can help control billing costs.

\n

To learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, @@ -162,7 +161,6 @@ "TrafficPercentageToMonitor": { "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.

\n

To learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, @@ -172,6 +170,9 @@ "smithy.api#documentation": "

Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a\n\t\t\thealth event when an internet issue that affects your application end users has a health score percentage that is at or below a \n\t\t\tspecific threshold, and, sometimes, when other criteria are met.

\n

If you don't set a health event threshold, the default value is 95%.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.internetmonitor#CreateMonitorOutput": { @@ -191,6 +192,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.internetmonitor#DeleteMonitor": { @@ -235,11 +239,55 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.internetmonitor#DeleteMonitorOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.internetmonitor#FilterList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.internetmonitor#FilterParameter": { + "type": "structure", + "members": { + "Field": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you \n\t\t\tcreated by running a query. A field might be city, for example. The field must be one of the fields\n\t\t\tthat was returned by the specific query that you used to create the repository.

" + } + }, + "Operator": { + "target": "com.amazonaws.internetmonitor#Operator", + "traits": { + "smithy.api#documentation": "

The operator to use with the filter field and a value, such as not_equals.

" + } + }, + "Values": { + "target": "com.amazonaws.internetmonitor#FilterList", + "traits": { + "smithy.api#documentation": "

One or more values to be used, together with the specified operator, to filter data for a query.\n\t\t\tFor example, you could specify an array of values such as [\"Seattle\", \"Redmond\"]. Values in the array are separated by\n\t\t\tcommas.

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

A filter that you use with the results of a Amazon CloudWatch Internet Monitor query that you created and ran. The query sets up a \n\t\t\trepository of data that is a subset of your application's Internet Monitor data. FilterParameter is a string \n\t\t\tthat defines how you want to filter the repository of data to return a set of results, based on your criteria.

\n

The filter parameters that you can specify depend on the query type that you used to create the repository, since \n\t\t\teach query type returns a different set of Internet Monitor data.

\n

For each filter, you specify a field (such as city), an operator (such as not_equals,\n\t\t\tand a value or array of values (such as [\"Seattle\", \"Redmond\"]). Separate values in the array with\n\t\t\tcommas.

\n

For more information about specifying filter parameters, see\n\t\t\tUsing the Amazon CloudWatch Internet Monitor query interface\n\t\t\tin the Amazon CloudWatch Internet Monitor User Guide.

" + } + }, + "com.amazonaws.internetmonitor#FilterParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#FilterParameter" + } }, "com.amazonaws.internetmonitor#GetHealthEvent": { "type": "operation", @@ -286,7 +334,7 @@ "EventId": { "target": "com.amazonaws.internetmonitor#HealthEventName", "traits": { - "smithy.api#documentation": "

The internally generated identifier of a health event. Because EventID contains the forward slash (“/”) character, you must \n\t\t\tURL-encode the EventID field in the request URL.

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

The internally-generated identifier of a health event. Because EventID contains the forward slash (“/”) character, you must \n\t\t\tURL-encode the EventID field in the request URL.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -306,7 +354,7 @@ "EventId": { "target": "com.amazonaws.internetmonitor#HealthEventName", "traits": { - "smithy.api#documentation": "

The internally generated identifier of a health event.

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

The internally-generated identifier of a health event.

", "smithy.api#required": {} } }, @@ -418,6 +466,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.internetmonitor#GetMonitorOutput": { @@ -488,7 +539,6 @@ "MaxCityNetworksToMonitor": { "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. This limit can help control billing costs.

\n

To learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, @@ -501,7 +551,6 @@ "TrafficPercentageToMonitor": { "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.

\n

To learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, @@ -511,6 +560,187 @@ "smithy.api#documentation": "

The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration \n\t\t\tinformation, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.internetmonitor#GetQueryResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#GetQueryResultsInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#GetQueryResultsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#LimitExceededException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing \n\t\t\ta QueryId and a monitor name.

\n

For more information about using the query interface, including examples, see\n\t\t\tUsing the Amazon CloudWatch Internet Monitor query interface\n\t\t\tin the Amazon CloudWatch Internet Monitor User Guide.

", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}/Queries/{QueryId}/Results", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#GetQueryResultsInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the monitor to return data for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the query that you want to return data results for. A QueryId is an \n\t\t\tinternally-generated identifier for a specific query.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. You receive this token from a previous call.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.internetmonitor#QueryMaxResults", + "traits": { + "smithy.api#documentation": "

The number of query results that you want to return with this call.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.internetmonitor#GetQueryResultsOutput": { + "type": "structure", + "members": { + "Fields": { + "target": "com.amazonaws.internetmonitor#QueryFields", + "traits": { + "smithy.api#documentation": "

The fields that the query returns data for. Fields are name-data type pairs, such as \n\t\t\tavailability_score-float.

", + "smithy.api#required": {} + } + }, + "Data": { + "target": "com.amazonaws.internetmonitor#QueryData", + "traits": { + "smithy.api#documentation": "

The data results that the query returns. Data is returned in arrays, aligned with the Fields\n\t\tfor the query, which creates a repository of Amazon CloudWatch Internet Monitor information for your application. Then, you can filter\n\t\tthe information in the repository by using FilterParameters that you define.

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

The token for the next set of results. You receive this token from a previous call.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.internetmonitor#GetQueryStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#GetQueryStatusInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#GetQueryStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#LimitExceededException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. \n\t\t\tWhen you run a query, check the status to make sure that the query has SUCCEEDED before you review the results.

\n ", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}/Queries/{QueryId}/Status", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#GetQueryStatusInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the monitor.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the query that you want to return the status for. A QueryId is an internally-generated \n\t\t\tdentifier for a specific query.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.internetmonitor#GetQueryStatusOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.internetmonitor#QueryStatus", + "traits": { + "smithy.api#documentation": "

The current status for a query.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.internetmonitor#HealthEvent": { @@ -526,7 +756,7 @@ "EventId": { "target": "com.amazonaws.internetmonitor#HealthEventName", "traits": { - "smithy.api#documentation": "

The internally generated identifier of a specific network traffic impairment health event.

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

The internally-generated identifier of a specific network traffic impairment health event.

", "smithy.api#required": {} } }, @@ -977,7 +1207,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1020,7 +1249,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1033,7 +1263,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1047,7 +1276,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1070,7 +1298,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1105,7 +1332,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1116,14 +1342,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1137,14 +1365,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -1153,11 +1379,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1168,14 +1394,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1189,7 +1417,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1209,7 +1436,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1220,14 +1446,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1238,9 +1466,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1652,7 +1882,6 @@ "MaxResults": { "target": "com.amazonaws.internetmonitor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of health event objects that you want to return with this call.

", "smithy.api#httpQuery": "MaxResults" } @@ -1734,7 +1963,6 @@ "MaxResults": { "target": "com.amazonaws.internetmonitor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of monitor objects that you want to return with this call.

", "smithy.api#httpQuery": "MaxResults" } @@ -1746,6 +1974,9 @@ "smithy.api#httpQuery": "MonitorStatus" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.internetmonitor#ListMonitorsOutput": { @@ -1764,6 +1995,9 @@ "smithy.api#documentation": "

The token for the next set of results. You receive this token from a previous call.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.internetmonitor#ListTagsForResource": { @@ -1854,12 +2088,12 @@ "target": "com.amazonaws.internetmonitor#Percentage", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a\n\t\t\tthreshold is crossed for a local health score.

" + "smithy.api#documentation": "

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a\n\t\t\tthreshold is crossed for a local health score.

\n

If you don't set a minimum traffic impact threshold, the default value is 0.01%.

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

A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event \n\t\t\tfor a local performance or availability issue, when scores cross a threshold for one or more city-networks.

\n

Defines the percentages, for performance scores or availability scores, that are the local thresholds\n\t\t\tfor when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage\n\t\t\tof overall traffic that must be impacted by an issue before Internet Monitor creates an event when a\tthreshold is crossed for a local health score.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" + "smithy.api#documentation": "

A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event \n\t\t\tfor a local performance or availability issue, when scores cross a threshold for one or more city-networks.

\n

Defines the percentages, for performance scores or availability scores, that are the local thresholds\n\t\t\tfor when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage\n\t\t\tof overall traffic that must be impacted by an issue before Internet Monitor creates an event when a\tthreshold is crossed for a local health score.

\n

If you don't set a local health event threshold, the default value is 60%.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" } }, "com.amazonaws.internetmonitor#LocalHealthEventsConfigStatus": { @@ -1895,7 +2129,6 @@ "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 500000 @@ -1905,7 +2138,6 @@ "com.amazonaws.internetmonitor#MaxResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 25 @@ -2039,6 +2271,20 @@ "list": { "target": "com.amazonaws.internetmonitor#ListMonitors" }, + "operations": [ + { + "target": "com.amazonaws.internetmonitor#GetQueryResults" + }, + { + "target": "com.amazonaws.internetmonitor#GetQueryStatus" + }, + { + "target": "com.amazonaws.internetmonitor#StartQuery" + }, + { + "target": "com.amazonaws.internetmonitor#StopQuery" + } + ], "resources": [ { "target": "com.amazonaws.internetmonitor#HealthEventResource" @@ -2127,6 +2373,21 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.internetmonitor#Operator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "EQUALS", + "value": "EQUALS" + }, + { + "name": "NOT_EQUALS", + "value": "NOT_EQUALS" + } + ] + } + }, "com.amazonaws.internetmonitor#Percentage": { "type": "double", "traits": { @@ -2169,6 +2430,99 @@ "smithy.api#documentation": "

Amazon CloudWatch Internet Monitor calculates measurements about the performance for your application's internet traffic between client locations and Amazon Web Services. \n\t\t\tAmazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

\n

Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for\n\t\t\tan end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.

\n

For more information, see How Internet Monitor calculates performance and availability\n\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, + "com.amazonaws.internetmonitor#QueryData": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#QueryRow" + } + }, + "com.amazonaws.internetmonitor#QueryField": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of a field to query your application's Amazon CloudWatch Internet Monitor data for, such as availability_score.

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

The data type for a query field, which must correspond to the field you're defining for QueryField. For example, if the query \n\t\t\tfield name is availability_score, the data type is float.

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

Defines a field to query for your application's Amazon CloudWatch Internet Monitor data. You create a data repository by running a query of a specific\n\t\t\ttype. Each QueryType includes a specific set of fields and datatypes to retrieve data for.

" + } + }, + "com.amazonaws.internetmonitor#QueryFields": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#QueryField" + } + }, + "com.amazonaws.internetmonitor#QueryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.internetmonitor#QueryRow": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.internetmonitor#QueryStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "QUEUED", + "value": "QUEUED" + }, + { + "name": "RUNNING", + "value": "RUNNING" + }, + { + "name": "SUCCEEDED", + "value": "SUCCEEDED" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "CANCELED", + "value": "CANCELED" + } + ] + } + }, + "com.amazonaws.internetmonitor#QueryType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "MEASUREMENTS", + "value": "MEASUREMENTS" + }, + { + "name": "TOP_LOCATIONS", + "value": "TOP_LOCATIONS" + }, + { + "name": "TOP_LOCATION_DETAILS", + "value": "TOP_LOCATION_DETAILS" + } + ] + } + }, "com.amazonaws.internetmonitor#ResourceName": { "type": "string", "traits": { @@ -2253,6 +2607,165 @@ "target": "com.amazonaws.internetmonitor#Arn" } }, + "com.amazonaws.internetmonitor#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#StartQueryInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#StartQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#LimitExceededException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period\n\t\t\tfor the data that you want returned by using StartTime and EndTime. You filter the query \n\t\t\tresults to return by providing parameters that you specify with FilterParameters.

\n

For more information about using the query interface, including examples, see\n\t\t\tUsing the Amazon CloudWatch Internet Monitor query interface\n\t\tin the Amazon CloudWatch Internet Monitor User Guide.

", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}/Queries", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#StartQueryInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the monitor to query.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

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

The timestamp that is the end of the period that you want to retrieve data for with your query.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "QueryType": { + "target": "com.amazonaws.internetmonitor#QueryType", + "traits": { + "smithy.api#documentation": "

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

\n \n

For lists of the fields returned with each query type and more information about how each type of query is\n\t\t\tperformed, see \n\t\t\t\tUsing the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

", + "smithy.api#required": {} + } + }, + "FilterParameters": { + "target": "com.amazonaws.internetmonitor#FilterParameters", + "traits": { + "smithy.api#documentation": "

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines \n\t\t\thow you want a query to be filtered. The filter parameters that you can specify depend on the query type, since \n\t\t\teach query type returns a different set of Internet Monitor data.

\n

For more information about specifying filter parameters, see\n\t\t\tUsing the Amazon CloudWatch Internet Monitor query interface\n\t\t\tin the Amazon CloudWatch Internet Monitor User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.internetmonitor#StartQueryOutput": { + "type": "structure", + "members": { + "QueryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The internally-generated identifier of a specific query.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.internetmonitor#StopQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#StopQueryInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#StopQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#LimitExceededException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stop a query that is progress for a specific monitor.

", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}/Queries/{QueryId}", + "method": "DELETE" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#StopQueryInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the monitor.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the query that you want to stop. A QueryId is an internally-generated identifier for a specific query.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.internetmonitor#StopQueryOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.internetmonitor#TagKey": { "type": "string", "traits": { @@ -2407,7 +2920,6 @@ "com.amazonaws.internetmonitor#TrafficPercentageToMonitor": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -2579,7 +3091,6 @@ "MaxCityNetworksToMonitor": { "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. Setting this limit can help control billing costs.

" } }, @@ -2592,7 +3103,6 @@ "TrafficPercentageToMonitor": { "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.

\n

To learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, @@ -2602,6 +3112,9 @@ "smithy.api#documentation": "

The list of health score thresholds. A threshold percentage for health scores, along with other configuration information,\n\t\t\tdetermines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.internetmonitor#UpdateMonitorOutput": { @@ -2621,6 +3134,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.internetmonitor#ValidationException": { diff --git a/codegen/sdk-codegen/aws-models/ivs.json b/codegen/sdk-codegen/aws-models/ivs.json index 2bb73f719b4..e538dfbd061 100644 --- a/codegen/sdk-codegen/aws-models/ivs.json +++ b/codegen/sdk-codegen/aws-models/ivs.json @@ -186,7 +186,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -229,7 +228,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -242,7 +242,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -256,7 +255,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -279,7 +277,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -314,7 +311,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -325,14 +321,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -346,14 +344,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -362,11 +358,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -377,14 +373,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -398,7 +396,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -418,7 +415,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -429,14 +425,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -447,9 +445,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2374,7 +2374,6 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxChannelResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of channels to return. Default: 100.

" } } @@ -2440,7 +2439,6 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxPlaybackKeyPairResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of key pairs to return. Default: your service quota or 100, whichever is\n smaller.

" } } @@ -2509,7 +2507,6 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxRecordingConfigurationResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of recording configurations to return. Default: your service quota or 100,\n whichever is smaller.

" } } @@ -2585,7 +2582,6 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxStreamKeyResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of streamKeys to return. Default: 1.

" } } @@ -2661,7 +2657,6 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxStreamResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of streams to return. Default: 100.

" } } @@ -2733,7 +2728,6 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxStreamResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of streams to return. Default: 100.

" } } @@ -2813,7 +2807,6 @@ "com.amazonaws.ivs#MaxChannelResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -2823,7 +2816,6 @@ "com.amazonaws.ivs#MaxPlaybackKeyPairResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -2833,7 +2825,6 @@ "com.amazonaws.ivs#MaxRecordingConfigurationResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -2843,7 +2834,6 @@ "com.amazonaws.ivs#MaxStreamKeyResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -2853,7 +2843,6 @@ "com.amazonaws.ivs#MaxStreamResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -3976,7 +3965,6 @@ "com.amazonaws.ivs#TargetIntervalSeconds": { "type": "long", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 60 @@ -4011,7 +3999,6 @@ "targetIntervalSeconds": { "target": "com.amazonaws.ivs#TargetIntervalSeconds", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The targeted thumbnail-generation interval in seconds. This is configurable (and required)\n only if recordingMode is INTERVAL. Default: 60.

\n

\n Important: For the BASIC channel type,\n setting a value for targetIntervalSeconds does not guarantee that thumbnails are\n generated at the specified interval. For thumbnails to be generated at the\n targetIntervalSeconds interval, the IDR/Keyframe value for the\n input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming\n Configuration for information on setting IDR/Keyframe to the\n recommended value in video-encoder settings.

" } }, diff --git a/codegen/sdk-codegen/aws-models/ivschat.json b/codegen/sdk-codegen/aws-models/ivschat.json index 448bf7db7b5..ea88277e5c9 100644 --- a/codegen/sdk-codegen/aws-models/ivschat.json +++ b/codegen/sdk-codegen/aws-models/ivschat.json @@ -147,7 +147,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -190,7 +189,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -203,7 +203,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -217,7 +216,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -240,7 +238,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -275,7 +272,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -286,14 +282,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -307,14 +305,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -323,11 +319,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -338,14 +334,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -359,7 +357,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -379,7 +376,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -390,14 +386,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -408,9 +406,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -772,7 +772,10 @@ } }, "com.amazonaws.ivschat#ChatToken": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.ivschat#ChatTokenAttributes": { "type": "map", @@ -781,6 +784,9 @@ }, "value": { "target": "com.amazonaws.ivschat#String" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.ivschat#ChatTokenCapabilities": { @@ -909,7 +915,6 @@ "sessionDurationInMinutes": { "target": "com.amazonaws.ivschat#SessionDurationInMinutes", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Session duration (in minutes), after which the session expires. Default: 60 (1\n hour).

" } }, @@ -1116,14 +1121,12 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients).\n Default: 10.

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" } }, @@ -1183,14 +1186,12 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients),\n from the request (if specified).

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of characters in a single message, from the request (if\n specified).

" } }, @@ -1692,14 +1693,12 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients).\n Default: 10.

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" } }, @@ -1807,7 +1806,6 @@ "maxResults": { "target": "com.amazonaws.ivschat#MaxLoggingConfigurationResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of logging configurations to return. Default: 50.

" } } @@ -1882,7 +1880,6 @@ "maxResults": { "target": "com.amazonaws.ivschat#MaxRoomResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of rooms to return. Default: 50.

" } }, @@ -2132,7 +2129,6 @@ "com.amazonaws.ivschat#MaxLoggingConfigurationResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -2142,7 +2138,6 @@ "com.amazonaws.ivschat#MaxRoomResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -2309,7 +2304,6 @@ "com.amazonaws.ivschat#RoomMaxMessageLength": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 500 @@ -2319,7 +2313,6 @@ "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -2516,7 +2509,6 @@ "com.amazonaws.ivschat#SessionDurationInMinutes": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 180 @@ -2889,14 +2881,12 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients).\n Default: 10.

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" } }, @@ -2950,14 +2940,12 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients),\n from the request (if specified).

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of characters in a single message, from the request (if\n specified).

" } }, @@ -2987,7 +2975,8 @@ "smithy.api#length": { "min": 1, "max": 128 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.ivschat#ValidationException": { diff --git a/codegen/sdk-codegen/aws-models/kinesis-video.json b/codegen/sdk-codegen/aws-models/kinesis-video.json index d6fdbc2ee87..cd047f4fc6b 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-video.json +++ b/codegen/sdk-codegen/aws-models/kinesis-video.json @@ -1014,7 +1014,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

\n \n

Returns the most current information about the channel. Specify the ChannelName\n or ChannelARN in the input.

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

Returns the most current information about the channel. Specify the ChannelName\n or ChannelARN in the input.

", "smithy.api#http": { "method": "POST", "uri": "/describeMediaStorageConfiguration", @@ -1882,7 +1882,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1925,7 +1924,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1938,7 +1938,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1952,7 +1951,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1975,7 +1973,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2010,7 +2007,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2021,14 +2017,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2042,14 +2040,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -2058,11 +2054,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2073,14 +2069,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2094,7 +2092,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2114,7 +2111,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2125,14 +2121,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2143,9 +2141,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -3310,7 +3310,7 @@ "StreamARN": { "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" } }, "Status": { @@ -3322,7 +3322,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration properties.

" + "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration\n properties.

\n " } }, "com.amazonaws.kinesisvideo#MediaStorageConfigurationStatus": { @@ -4361,7 +4361,7 @@ } ], "traits": { - "smithy.api#documentation": "

Increases or decreases the stream's data retention period by the value that you\n specify. To indicate whether you want to increase or decrease the data retention period,\n specify the Operation parameter in the request body. In the request, you\n must specify either the StreamName or the StreamARN.

\n \n

The retention period that you specify replaces the current value.

\n \n

This operation requires permission for the\n KinesisVideo:UpdateDataRetention action.

\n

Changing the data retention period affects the data in the stream as\n follows:

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

Increases or decreases the stream's data retention period by the value that you\n specify. To indicate whether you want to increase or decrease the data retention period,\n specify the Operation parameter in the request body. In the request, you\n must specify either the StreamName or the StreamARN.

\n

This operation requires permission for the\n KinesisVideo:UpdateDataRetention action.

\n

Changing the data retention period affects the data in the stream as\n follows:

\n ", "smithy.api#http": { "method": "POST", "uri": "/updateDataRetention", @@ -4401,7 +4401,7 @@ "DataRetentionChangeInHours": { "target": "com.amazonaws.kinesisvideo#DataRetentionChangeInHours", "traits": { - "smithy.api#documentation": "

The retention period, in hours. The value you specify replaces the current value.\n The maximum value for this parameter is 87600 (ten years).

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

The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the operation.

\n

The minimum value for data retention is 0 and the maximum value is 87600 (ten years).

", "smithy.api#required": {} } } @@ -4533,7 +4533,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

\n \n

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that \n can specified :

\n \n \n

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no\n longer occur. Peers connect directly to the storage session. You must call the\n JoinStorageSession API to trigger an SDP offer send and establish a\n connection between a peer and the storage session.

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

Associates a SignalingChannel to a stream to store the media. There are\n two signaling modes that you can specify :

\n \n \n

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no\n longer occur. Peers connect directly to the storage session. You must call the\n JoinStorageSession API to trigger an SDP offer send and establish a\n connection between a peer and the storage session.

\n ", "smithy.api#http": { "method": "POST", "uri": "/updateMediaStorageConfiguration", diff --git a/codegen/sdk-codegen/aws-models/location.json b/codegen/sdk-codegen/aws-models/location.json index a2bc0559a95..f6209097b4b 100644 --- a/codegen/sdk-codegen/aws-models/location.json +++ b/codegen/sdk-codegen/aws-models/location.json @@ -86,6 +86,9 @@ "aws.api#arn": { "template": "api-key/{KeyName}" }, + "aws.cloudformation#cfnResource": { + "name": "APIKey" + }, "aws.iam#disableConditionKeyInference": {} } }, @@ -1587,6 +1590,7 @@ "KmsKeyId": { "target": "com.amazonaws.location#KmsKeyId", "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

A key identifier for an \n Amazon Web Services \n KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.\n\t

" } } @@ -1780,6 +1784,7 @@ "MapName": { "target": "com.amazonaws.location#ResourceName", "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

The name for the map resource.

\n

Requirements:

\n ", "smithy.api#required": {} } @@ -1787,6 +1792,7 @@ "Configuration": { "target": "com.amazonaws.location#MapConfiguration", "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

Specifies the MapConfiguration, including the map style, for the \n map resource that you create. The map style defines the look of maps and the data \n provider for your map resource.

", "smithy.api#required": {} } @@ -1894,6 +1900,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

Specifies the geospatial data provider for the new place index.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

", "smithy.api#required": {} } @@ -2007,6 +2014,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

Specifies the data provider of traffic and road network data.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

", "smithy.api#required": {} } @@ -2124,6 +2132,7 @@ "KmsKeyId": { "target": "com.amazonaws.location#KmsKeyId", "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

A key identifier for an \n Amazon Web Services \n KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

" } }, @@ -2659,6 +2668,7 @@ "GeofenceCount": { "target": "smithy.api#Integer", "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The number of geofences in the geofence collection.

", "smithy.api#range": { "min": 0 @@ -2723,6 +2733,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The key value/string of an API key.

", "smithy.api#required": {} } @@ -2862,6 +2873,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

Specifies the data provider for the associated map tiles.

", "smithy.api#required": {} } @@ -3232,6 +3244,7 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The tags associated with the tracker resource.

" } }, @@ -3565,6 +3578,9 @@ "aws.api#arn": { "template": "geofence-collection/{CollectionName}" }, + "aws.cloudformation#cfnResource": { + "name": "GeofenceCollection" + }, "aws.iam#disableConditionKeyInference": {} } }, @@ -3708,6 +3724,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of device positions returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -4616,6 +4633,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of entries returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -4748,6 +4766,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of resources returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -4961,6 +4980,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of geofences returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -5034,6 +5054,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of resources returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -5173,6 +5194,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of resources returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -5311,6 +5333,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the maximum number of results returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -5449,6 +5472,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional maximum number of results returned in a single call.

\n

Default Value: 100\n

", "smithy.api#range": { "min": 1, @@ -5659,6 +5683,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of resources returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -5738,6 +5763,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional limit for the number of resources returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, @@ -5912,7 +5938,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5955,7 +5980,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -5968,7 +5994,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5982,7 +6007,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6005,7 +6029,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6040,7 +6063,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -6051,14 +6073,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -6072,14 +6096,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -6088,11 +6110,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -6103,14 +6125,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -6124,7 +6148,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6144,7 +6167,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -6155,14 +6177,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -6173,9 +6197,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -6575,6 +6601,9 @@ "aws.api#arn": { "template": "map/{MapName}" }, + "aws.cloudformation#cfnResource": { + "name": "Map" + }, "aws.iam#disableConditionKeyInference": {} } }, @@ -6769,13 +6798,15 @@ "aws.api#arn": { "template": "place-index/{IndexName}" }, + "aws.cloudformation#cfnResource": { + "name": "PlaceIndex" + }, "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.location#PlaceIndexSearchResultLimit": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 50 @@ -7093,6 +7124,9 @@ "aws.api#arn": { "template": "route-calculator/{CalculatorName}" }, + "aws.cloudformation#cfnResource": { + "name": "RouteCalculator" + }, "aws.iam#disableConditionKeyInference": {} } }, @@ -7366,7 +7400,6 @@ "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

Default value: 50\n

" } }, @@ -7417,7 +7450,6 @@ "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Contains the optional result count limit that is specified in the request.

\n

Default value: 50\n

" } }, @@ -7519,6 +7551,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

The default: 5\n

", "smithy.api#range": { "min": 1, @@ -7704,7 +7737,6 @@ "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

The default: 50\n

" } }, @@ -7779,7 +7811,6 @@ "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Contains the optional result count limit specified in the request.

" } }, @@ -8437,6 +8468,7 @@ "KeyName": { "target": "com.amazonaws.location#ResourceName", "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

The name of the API key resource to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} @@ -8567,6 +8599,7 @@ "ConfigurationUpdate": { "target": "com.amazonaws.location#MapConfigurationUpdate", "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

Updates the parts of the map configuration that can be updated, including the\n political view.

" } } diff --git a/codegen/sdk-codegen/aws-models/medialive.json b/codegen/sdk-codegen/aws-models/medialive.json index 272e6b1ef27..dba1a003782 100644 --- a/codegen/sdk-codegen/aws-models/medialive.json +++ b/codegen/sdk-codegen/aws-models/medialive.json @@ -5043,7 +5043,7 @@ } ], "traits": { - "smithy.api#documentation": "Get account configuration", + "smithy.api#documentation": "Describe account configuration", "smithy.api#http": { "method": "GET", "uri": "/prod/accountConfiguration", @@ -8708,6 +8708,13 @@ "smithy.api#documentation": "Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled.\nIf you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule.", "smithy.api#jsonName": "inputPrepareScheduleActions" } + }, + "OutputStaticImageOverlayScheduleActions": { + "target": "com.amazonaws.medialive#FeatureActivationsOutputStaticImageOverlayScheduleActions", + "traits": { + "smithy.api#documentation": "Enables the output static image overlay feature. Enabling this feature allows you to send channel schedule updates\nto display/clear/modify image overlays on an output-by-output bases.", + "smithy.api#jsonName": "outputStaticImageOverlayScheduleActions" + } } }, "traits": { @@ -8734,6 +8741,26 @@ "smithy.api#documentation": "Feature Activations Input Prepare Schedule Actions" } }, + "com.amazonaws.medialive#FeatureActivationsOutputStaticImageOverlayScheduleActions": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Feature Activations Output Static Image Overlay Schedule Actions" + } + }, "com.amazonaws.medialive#FecOutputIncludeFec": { "type": "enum", "members": { @@ -20701,6 +20728,20 @@ "smithy.api#documentation": "Action to deactivate a static image overlay", "smithy.api#jsonName": "staticImageDeactivateSettings" } + }, + "StaticImageOutputActivateSettings": { + "target": "com.amazonaws.medialive#StaticImageOutputActivateScheduleActionSettings", + "traits": { + "smithy.api#documentation": "Action to activate a static image overlay in one or more specified outputs", + "smithy.api#jsonName": "staticImageOutputActivateSettings" + } + }, + "StaticImageOutputDeactivateSettings": { + "target": "com.amazonaws.medialive#StaticImageOutputDeactivateScheduleActionSettings", + "traits": { + "smithy.api#documentation": "Action to deactivate a static image overlay in one or more specified outputs", + "smithy.api#jsonName": "staticImageOutputDeactivateSettings" + } } }, "traits": { @@ -21909,7 +21950,7 @@ "InputDeviceId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef.", + "smithy.api#documentation": "The unique ID of the input device to start. For example, hd-123456789abcdef.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -22184,6 +22225,126 @@ "smithy.api#documentation": "Settings for the action to deactivate the image in a specific layer." } }, + "com.amazonaws.medialive#StaticImageOutputActivateScheduleActionSettings": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.", + "smithy.api#jsonName": "duration" + } + }, + "FadeIn": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).", + "smithy.api#jsonName": "fadeIn" + } + }, + "FadeOut": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).", + "smithy.api#jsonName": "fadeOut" + } + }, + "Height": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.", + "smithy.api#jsonName": "height" + } + }, + "Image": { + "target": "com.amazonaws.medialive#InputLocation", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.", + "smithy.api#jsonName": "image", + "smithy.api#required": {} + } + }, + "ImageX": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.", + "smithy.api#jsonName": "imageX" + } + }, + "ImageY": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.", + "smithy.api#jsonName": "imageY" + } + }, + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", + "traits": { + "smithy.api#documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.", + "smithy.api#jsonName": "layer" + } + }, + "Opacity": { + "target": "com.amazonaws.medialive#__integerMin0Max100", + "traits": { + "smithy.api#documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.", + "smithy.api#jsonName": "opacity" + } + }, + "OutputNames": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name(s) of the output(s) the activation should apply to.", + "smithy.api#jsonName": "outputNames", + "smithy.api#required": {} + } + }, + "Width": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.", + "smithy.api#jsonName": "width" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the action to activate a static image." + } + }, + "com.amazonaws.medialive#StaticImageOutputDeactivateScheduleActionSettings": { + "type": "structure", + "members": { + "FadeOut": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out).", + "smithy.api#jsonName": "fadeOut" + } + }, + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", + "traits": { + "smithy.api#documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0.", + "smithy.api#jsonName": "layer" + } + }, + "OutputNames": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name(s) of the output(s) the deactivation should apply to.", + "smithy.api#jsonName": "outputNames", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the action to deactivate the image in a specific layer." + } + }, "com.amazonaws.medialive#StaticKeySettings": { "type": "structure", "members": { @@ -22450,7 +22611,7 @@ "InputDeviceId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef.", + "smithy.api#documentation": "The unique ID of the input device to stop. For example, hd-123456789abcdef.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -22872,7 +23033,7 @@ "target": "com.amazonaws.medialive#ThumbnailState", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether Thumbnail is enabled.", + "smithy.api#documentation": "Enables the thumbnail feature. The feature generates thumbnails of the incoming video in each pipeline in the channel. AUTO turns the feature on, DISABLE turns the feature off.", "smithy.api#jsonName": "state", "smithy.api#required": {} } diff --git a/codegen/sdk-codegen/aws-models/mgn.json b/codegen/sdk-codegen/aws-models/mgn.json index 2c694fdfdac..8ae74650213 100644 --- a/codegen/sdk-codegen/aws-models/mgn.json +++ b/codegen/sdk-codegen/aws-models/mgn.json @@ -452,7 +452,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -495,7 +494,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -508,7 +508,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -522,7 +521,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -545,7 +543,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -580,7 +577,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -591,14 +587,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -612,14 +610,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -628,11 +624,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -643,14 +639,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -664,7 +662,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -684,7 +681,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -695,14 +691,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -713,9 +711,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -3203,7 +3203,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Request to describe Job log item maximum results.

" } }, @@ -3282,7 +3281,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Request to describe job log items by max results.

" } }, @@ -3402,7 +3400,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum results to be returned in DescribeLaunchConfigurationTemplates.

" } }, @@ -3478,7 +3475,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Request to describe Replication Configuration template by max results.

" } }, @@ -3551,7 +3547,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Request to filter Source Servers list by maximum results.

" } }, @@ -3689,7 +3684,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum results to be returned in DescribeVcenterClients.

", "smithy.api#httpQuery": "maxResults" } @@ -4809,7 +4803,6 @@ "com.amazonaws.mgn#Iops": { "type": "long", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 100, "max": 64000 @@ -5449,14 +5442,12 @@ "iops": { "target": "com.amazonaws.mgn#Iops", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Launch template disk iops configuration.

" } }, "throughput": { "target": "com.amazonaws.mgn#Throughput", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Launch template disk throughput configuration.

" } } @@ -5803,7 +5794,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum results to return when listing applications.

" } }, @@ -5908,7 +5898,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

List Connectors Request max results.

" } }, @@ -6002,7 +5991,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

List export errors request max results.

" } }, @@ -6075,7 +6063,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

List export request max results.

" } }, @@ -6181,7 +6168,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

List import errors request max results.

" } }, @@ -6260,7 +6246,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

List imports request max results.

" } }, @@ -6347,7 +6332,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

List managed accounts request max results.

" } }, @@ -6436,7 +6420,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum amount of items to return when listing source server post migration custom actions.

" } }, @@ -6580,7 +6563,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum amount of items to return when listing template post migration custom actions.

" } }, @@ -6650,7 +6632,6 @@ "maxResults": { "target": "com.amazonaws.mgn#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum results to return when listing waves.

" } }, @@ -6780,7 +6761,6 @@ "com.amazonaws.mgn#MaxResultsType": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 1000 @@ -6848,7 +6828,6 @@ "com.amazonaws.mgn#OrderType": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1001, "max": 10000 @@ -7127,7 +7106,6 @@ "order": { "target": "com.amazonaws.mgn#OrderType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Source server post migration custom action order.

", "smithy.api#required": {} } @@ -7154,7 +7132,6 @@ "timeoutSeconds": { "target": "com.amazonaws.mgn#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Source server post migration custom action timeout in seconds.

" } }, @@ -7254,7 +7231,6 @@ "order": { "target": "com.amazonaws.mgn#OrderType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Template post migration custom action order.

", "smithy.api#required": {} } @@ -7281,7 +7257,6 @@ "timeoutSeconds": { "target": "com.amazonaws.mgn#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Template post migration custom action timeout in seconds.

" } }, @@ -8102,7 +8077,6 @@ "quotaValue": { "target": "com.amazonaws.mgn#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Exceeded the service quota value.

" } } @@ -8299,7 +8273,6 @@ "order": { "target": "com.amazonaws.mgn#OrderType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Source server post migration custom action order.

" } }, @@ -8318,7 +8291,6 @@ "timeoutSeconds": { "target": "com.amazonaws.mgn#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Source server post migration custom action timeout in seconds.

" } }, @@ -8522,7 +8494,6 @@ "timeoutSeconds": { "target": "com.amazonaws.mgn#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

AWS Systems Manager Document timeout seconds.

" } }, @@ -9105,7 +9076,6 @@ "com.amazonaws.mgn#StrictlyPositiveInteger": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -9257,7 +9227,6 @@ "order": { "target": "com.amazonaws.mgn#OrderType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Template post migration custom action order.

" } }, @@ -9276,7 +9245,6 @@ "timeoutSeconds": { "target": "com.amazonaws.mgn#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Template post migration custom action timeout in seconds.

" } }, @@ -9457,7 +9425,6 @@ "com.amazonaws.mgn#Throughput": { "type": "long", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 125, "max": 1000 diff --git a/codegen/sdk-codegen/aws-models/osis.json b/codegen/sdk-codegen/aws-models/osis.json index 750f34814f6..d1db83f403b 100644 --- a/codegen/sdk-codegen/aws-models/osis.json +++ b/codegen/sdk-codegen/aws-models/osis.json @@ -148,7 +148,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -167,7 +166,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -195,13 +193,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -214,7 +213,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -228,7 +226,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -251,7 +248,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -286,11 +282,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -301,16 +295,19 @@ }, "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": [ @@ -324,14 +321,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -340,15 +335,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -359,16 +353,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -382,7 +379,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -402,11 +398,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -417,20 +411,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -441,18 +437,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -775,6 +775,21 @@ "com.amazonaws.osis#Boolean": { "type": "boolean" }, + "com.amazonaws.osis#BufferOptions": { + "type": "structure", + "members": { + "PersistentBufferEnabled": { + "target": "com.amazonaws.osis#Boolean", + "traits": { + "smithy.api#documentation": "

Whether persistent buffering should be enabled.

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

Options that specify the configuration of a persistent buffer.\n To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.

" + } + }, "com.amazonaws.osis#ChangeProgressStage": { "type": "structure", "members": { @@ -959,6 +974,9 @@ { "target": "com.amazonaws.osis#ResourceAlreadyExistsException" }, + { + "target": "com.amazonaws.osis#ResourceNotFoundException" + }, { "target": "com.amazonaws.osis#ValidationException" } @@ -1015,6 +1033,18 @@ "smithy.api#documentation": "

Container for the values required to configure VPC access for the pipeline. If you don't specify\n these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

" } }, + "BufferOptions": { + "target": "com.amazonaws.osis#BufferOptions", + "traits": { + "smithy.api#documentation": "

Key-value pairs to configure persistent buffering for the pipeline.

" + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.osis#EncryptionAtRestOptions", + "traits": { + "smithy.api#documentation": "

Key-value pairs to configure encryption for data that is written to a persistent buffer.

" + } + }, "Tags": { "target": "com.amazonaws.osis#TagList", "traits": { @@ -1097,6 +1127,21 @@ "smithy.api#output": {} } }, + "com.amazonaws.osis#EncryptionAtRestOptions": { + "type": "structure", + "members": { + "KmsKeyArn": { + "target": "com.amazonaws.osis#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion.\n By default, data is encrypted using an AWS owned key.

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

Options to control how OpenSearch encrypts all data-at-rest.

" + } + }, "com.amazonaws.osis#ErrorMessage": { "type": "string" }, @@ -1321,6 +1366,15 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.osis#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 2048 + } + } + }, "com.amazonaws.osis#LimitExceededException": { "type": "structure", "members": { @@ -1650,6 +1704,24 @@ "traits": { "smithy.api#documentation": "

The VPC interface endpoints that have access to the pipeline.

" } + }, + "BufferOptions": { + "target": "com.amazonaws.osis#BufferOptions" + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.osis#EncryptionAtRestOptions" + }, + "ServiceVpcEndpoints": { + "target": "com.amazonaws.osis#ServiceVpcEndpointsList", + "traits": { + "smithy.api#documentation": "

A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

" + } + }, + "Tags": { + "target": "com.amazonaws.osis#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the given pipeline.

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

The date and time when the pipeline was last updated.

" } + }, + "Tags": { + "target": "com.amazonaws.osis#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the given pipeline.

" + } } }, "traits": { @@ -1867,8 +1945,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1, - "max": 96 + "min": 1 } } }, @@ -1920,6 +1997,32 @@ } } }, + "com.amazonaws.osis#ServiceVpcEndpoint": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.osis#VpcEndpointServiceName", + "traits": { + "smithy.api#documentation": "

The name of the service for which a VPC endpoint was created.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC endpoint that was created.

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

A container for information about VPC endpoints that were created to other services

" + } + }, + "com.amazonaws.osis#ServiceVpcEndpointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.osis#ServiceVpcEndpoint" + } + }, "com.amazonaws.osis#StartPipeline": { "type": "operation", "input": { @@ -2317,6 +2420,18 @@ "traits": { "smithy.api#documentation": "

Key-value pairs to configure log publishing.

" } + }, + "BufferOptions": { + "target": "com.amazonaws.osis#BufferOptions", + "traits": { + "smithy.api#documentation": "

Key-value pairs to configure persistent buffering for the pipeline.

" + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.osis#EncryptionAtRestOptions", + "traits": { + "smithy.api#documentation": "

Key-value pairs to configure encryption for data that is written to a persistent buffer.

" + } } }, "traits": { @@ -2459,6 +2574,17 @@ "smithy.api#documentation": "

An OpenSearch Ingestion-managed VPC endpoint that will access one or more\n pipelines.

" } }, + "com.amazonaws.osis#VpcEndpointServiceName": { + "type": "enum", + "members": { + "OPENSEARCH_SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" + } + } + } + }, "com.amazonaws.osis#VpcEndpointsList": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/pipes.json b/codegen/sdk-codegen/aws-models/pipes.json index 3e2e217c4ca..7badf2b3bde 100644 --- a/codegen/sdk-codegen/aws-models/pipes.json +++ b/codegen/sdk-codegen/aws-models/pipes.json @@ -79,7 +79,6 @@ "Size": { "target": "com.amazonaws.pipes#BatchArraySize", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The size of the array, if this is an array batch job.

" } } @@ -91,7 +90,6 @@ "com.amazonaws.pipes#BatchArraySize": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 2, "max": 10000 @@ -262,7 +260,6 @@ "com.amazonaws.pipes#BatchRetryAttempts": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 10 @@ -275,7 +272,6 @@ "Attempts": { "target": "com.amazonaws.pipes#BatchRetryAttempts", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on \n failure the same number of attempts as the value.

" } } @@ -1057,7 +1053,6 @@ "sizeInGiB": { "target": "com.amazonaws.pipes#EphemeralStorageSize", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n supported value is 21 GiB and the maximum supported value is\n 200 GiB.

", "smithy.api#required": {} } @@ -1200,7 +1195,6 @@ "com.amazonaws.pipes#EphemeralStorageSize": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 21, "max": 200 diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index d255f7701f1..bb444720ab7 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -3045,7 +3045,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies the specified DB cluster parameter group.

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

Copies the specified DB cluster parameter group.

\n \n

You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies\n the default parameters and values for the specified DB cluster parameter group family.

\n ", "smithy.api#examples": [ { "title": "To copy a DB cluster parameter group", @@ -3260,7 +3260,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies the specified DB parameter group.

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

Copies the specified DB parameter group.

\n \n

You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default\n parameters and values for the specified DB parameter group family.

\n ", "smithy.api#examples": [ { "title": "To copy a DB parameter group", @@ -3851,6 +3851,9 @@ { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" + }, { "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" }, @@ -3866,6 +3869,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" } @@ -6947,6 +6953,12 @@ "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n cluster.

" } }, + "StatusInfos": { + "target": "com.amazonaws.rds#DBClusterStatusInfoList", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, "DBClusterMembers": { "target": "com.amazonaws.rds#DBClusterMemberList", "traits": { @@ -8351,6 +8363,47 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.rds#DBClusterStatusInfo": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "Normal": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Reserved for future use.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Reserved for future use.

" + } + }, + "com.amazonaws.rds#DBClusterStatusInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterStatusInfo", + "traits": { + "smithy.api#xmlName": "DBClusterStatusInfo" + } + } + }, "com.amazonaws.rds#DBEngineVersion": { "type": "structure", "members": { @@ -20052,6 +20105,9 @@ { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, @@ -23748,6 +23804,12 @@ "traits": { "smithy.api#documentation": "

Reserved for future use.

" } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/redshift-serverless.json b/codegen/sdk-codegen/aws-models/redshift-serverless.json index 1d118ccc863..8b4cc5d0641 100644 --- a/codegen/sdk-codegen/aws-models/redshift-serverless.json +++ b/codegen/sdk-codegen/aws-models/redshift-serverless.json @@ -465,6 +465,12 @@ "traits": { "smithy.api#documentation": "

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. \n You can only use this parameter if manageAdminPassword is true.

" } + }, + "redshiftIdcApplicationArn": { + "target": "com.amazonaws.redshiftserverless#RedshiftIdcApplicationArn", + "traits": { + "smithy.api#documentation": "

The ARN for the Redshift application that integrates with IAM Identity Center.

" + } } }, "traits": { @@ -3160,6 +3166,15 @@ } ] }, + "com.amazonaws.redshiftserverless#RedshiftIdcApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.redshiftserverless#RedshiftServerless": { "type": "service", "version": "2021-04-21", diff --git a/codegen/sdk-codegen/aws-models/redshift.json b/codegen/sdk-codegen/aws-models/redshift.json index 0091bd76b42..5ad6da703ce 100644 --- a/codegen/sdk-codegen/aws-models/redshift.json +++ b/codegen/sdk-codegen/aws-models/redshift.json @@ -859,6 +859,38 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#AuthorizedAudienceList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#String" + } + }, + "com.amazonaws.redshift#AuthorizedTokenIssuer": { + "type": "structure", + "members": { + "TrustedTokenIssuerArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The ARN for the authorized token issuer for integrating Amazon Redshift with IDC Identity Center.

" + } + }, + "AuthorizedAudiencesList": { + "target": "com.amazonaws.redshift#AuthorizedAudienceList", + "traits": { + "smithy.api#documentation": "

The list of audiences for the authorized token issuer for integrating Amazon Redshift \n with IDC Identity Center.

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

The authorized token issuer for the Amazon Redshift IAM Identity Center application.

" + } + }, + "com.amazonaws.redshift#AuthorizedTokenIssuerList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#AuthorizedTokenIssuer" + } + }, "com.amazonaws.redshift#AvailabilityZone": { "type": "structure", "members": { @@ -2723,6 +2755,9 @@ { "target": "com.amazonaws.redshift#NumberOfNodesQuotaExceededFault" }, + { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationNotExistsFault" + }, { "target": "com.amazonaws.redshift#SnapshotScheduleNotFoundFault" }, @@ -2976,6 +3011,12 @@ "traits": { "smithy.api#documentation": "

If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

" } + }, + "RedshiftIdcApplicationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

" + } } }, "traits": { @@ -3761,6 +3802,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#CreateRedshiftIdcApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#CreateRedshiftIdcApplicationMessage" + }, + "output": { + "target": "com.amazonaws.redshift#CreateRedshiftIdcApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#DependentServiceAccessDeniedFault" + }, + { + "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" + }, + { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationQuotaExceededFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Redshift application for use with IAM Identity Center.

" + } + }, + "com.amazonaws.redshift#CreateRedshiftIdcApplicationMessage": { + "type": "structure", + "members": { + "IdcInstanceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.

", + "smithy.api#required": {} + } + }, + "RedshiftIdcApplicationName": { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Redshift application in IAM Identity Center.

", + "smithy.api#required": {} + } + }, + "IdentityNamespace": { + "target": "com.amazonaws.redshift#IdentityNamespaceString", + "traits": { + "smithy.api#documentation": "

The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application \n verifies the connection token.

" + } + }, + "IdcDisplayName": { + "target": "com.amazonaws.redshift#IdcDisplayNameString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The display name for the Amazon Redshift IAM Identity Center application instance. It appears in the console.

", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions \n to be assumed and invoke the IDC Identity Center API.

", + "smithy.api#required": {} + } + }, + "AuthorizedTokenIssuerList": { + "target": "com.amazonaws.redshift#AuthorizedTokenIssuerList", + "traits": { + "smithy.api#documentation": "

The token issuer list for the Amazon Redshift IAM Identity Center application instance.

" + } + }, + "ServiceIntegrations": { + "target": "com.amazonaws.redshift#ServiceIntegrationList", + "traits": { + "smithy.api#documentation": "

A collection of service integrations for the Redshift IAM Identity Center application.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#CreateRedshiftIdcApplicationResult": { + "type": "structure", + "members": { + "RedshiftIdcApplication": { + "target": "com.amazonaws.redshift#RedshiftIdcApplication" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#CreateScheduledAction": { "type": "operation", "input": { @@ -5115,6 +5254,48 @@ "smithy.api#documentation": "

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

" } }, + "com.amazonaws.redshift#DeleteRedshiftIdcApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DeleteRedshiftIdcApplicationMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#DependentServiceAccessDeniedFault" + }, + { + "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" + }, + { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationNotExistsFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Redshift IAM Identity Center application.

" + } + }, + "com.amazonaws.redshift#DeleteRedshiftIdcApplicationMessage": { + "type": "structure", + "members": { + "RedshiftIdcApplicationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN for a deleted Amazon Redshift IAM Identity Center application.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.redshift#DeleteResourcePolicy": { "type": "operation", "input": { @@ -5341,6 +5522,23 @@ "smithy.api#input": {} } }, + "com.amazonaws.redshift#DependentServiceAccessDeniedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DependentServiceAccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

A dependent service denied access for the integration.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.redshift#DependentServiceRequestThrottlingFault": { "type": "structure", "members": { @@ -7249,6 +7447,84 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#DescribeRedshiftIdcApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DescribeRedshiftIdcApplicationsMessage" + }, + "output": { + "target": "com.amazonaws.redshift#DescribeRedshiftIdcApplicationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#DependentServiceAccessDeniedFault" + }, + { + "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" + }, + { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationNotExistsFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon Redshift IAM Identity Center applications.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "RedshiftIdcApplications", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.redshift#DescribeRedshiftIdcApplicationsMessage": { + "type": "structure", + "members": { + "RedshiftIdcApplicationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Redshift application that integrates with IAM Identity Center.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of response records to return in each call. If the number of remaining response records \n exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve \n the next set of records by retrying the command with the returned marker value.

" + } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a \n value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#DescribeRedshiftIdcApplicationsResult": { + "type": "structure", + "members": { + "RedshiftIdcApplications": { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Redshift IAM Identity Center applications.

" + } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the starting point for the next set of response records in a subsequent \n request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#DescribeReservedNodeExchangeStatus": { "type": "operation", "input": { @@ -9664,6 +9940,26 @@ } } }, + "com.amazonaws.redshift#IdcDisplayNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.redshift#IdentityNamespaceString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_+.#@$-]+$" + } + }, "com.amazonaws.redshift#ImportTablesCompleted": { "type": "list", "member": { @@ -10421,6 +10717,42 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#LakeFormationQuery": { + "type": "structure", + "members": { + "Authorization": { + "target": "com.amazonaws.redshift#ServiceAuthorization", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Determines whether the query scope is enabled or disabled.

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

The Lake Formation scope.

" + } + }, + "com.amazonaws.redshift#LakeFormationScopeUnion": { + "type": "union", + "members": { + "LakeFormationQuery": { + "target": "com.amazonaws.redshift#LakeFormationQuery", + "traits": { + "smithy.api#documentation": "

The Lake Formation scope.

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

A list of scopes set up for Lake Formation integration.

" + } + }, + "com.amazonaws.redshift#LakeFormationServiceIntegrations": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#LakeFormationScopeUnion" + } + }, "com.amazonaws.redshift#LimitExceededFault": { "type": "structure", "members": { @@ -11653,6 +11985,89 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#ModifyRedshiftIdcApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#ModifyRedshiftIdcApplicationMessage" + }, + "output": { + "target": "com.amazonaws.redshift#ModifyRedshiftIdcApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#DependentServiceAccessDeniedFault" + }, + { + "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" + }, + { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationNotExistsFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes an existing Amazon Redshift IAM Identity Center application.

" + } + }, + "com.amazonaws.redshift#ModifyRedshiftIdcApplicationMessage": { + "type": "structure", + "members": { + "RedshiftIdcApplicationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN for the Redshift application that integrates with IAM Identity Center.

", + "smithy.api#required": {} + } + }, + "IdentityNamespace": { + "target": "com.amazonaws.redshift#IdentityNamespaceString", + "traits": { + "smithy.api#documentation": "

The namespace for the Amazon Redshift IAM Identity Center application to change. It determines which managed application \n verifies the connection token.

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The IAM role ARN associated with the Amazon Redshift IAM Identity Center application to change. It has the required permissions \n to be assumed and invoke the IDC Identity Center API.

" + } + }, + "IdcDisplayName": { + "target": "com.amazonaws.redshift#IdcDisplayNameString", + "traits": { + "smithy.api#documentation": "

The display name for the Amazon Redshift IAM Identity Center application to change. It appears on the console.

" + } + }, + "AuthorizedTokenIssuerList": { + "target": "com.amazonaws.redshift#AuthorizedTokenIssuerList", + "traits": { + "smithy.api#documentation": "

The authorized token issuer list for the Amazon Redshift IAM Identity Center application to change.

" + } + }, + "ServiceIntegrations": { + "target": "com.amazonaws.redshift#ServiceIntegrationList", + "traits": { + "smithy.api#documentation": "

A collection of service integrations associated with the application.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#ModifyRedshiftIdcApplicationResult": { + "type": "structure", + "members": { + "RedshiftIdcApplication": { + "target": "com.amazonaws.redshift#RedshiftIdcApplication" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#ModifyScheduledAction": { "type": "operation", "input": { @@ -12862,6 +13277,141 @@ } } }, + "com.amazonaws.redshift#RedshiftIdcApplication": { + "type": "structure", + "members": { + "IdcInstanceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM Identity Center instance that Redshift integrates with.

" + } + }, + "RedshiftIdcApplicationName": { + "target": "com.amazonaws.redshift#RedshiftIdcApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the Redshift application in IAM Identity Center.

" + } + }, + "RedshiftIdcApplicationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Redshift application that integrates with IAM Identity Center.

" + } + }, + "IdentityNamespace": { + "target": "com.amazonaws.redshift#IdentityNamespaceString", + "traits": { + "smithy.api#documentation": "

The identity namespace for the Amazon Redshift IAM Identity Center application. It determines which managed application verifies the connection token.

" + } + }, + "IdcDisplayName": { + "target": "com.amazonaws.redshift#IdcDisplayNameString", + "traits": { + "smithy.api#documentation": "

The display name for the Amazon Redshift IAM Identity Center application. It appears on the console.

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Amazon Redshift IAM Identity Center application. It has the required permissions to be assumed and invoke the IDC Identity Center API.

" + } + }, + "IdcManagedApplicationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Amazon Redshift IAM Identity Center application.

" + } + }, + "IdcOnboardStatus": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The onboarding status for the Amazon Redshift IAM Identity Center application.

" + } + }, + "AuthorizedTokenIssuerList": { + "target": "com.amazonaws.redshift#AuthorizedTokenIssuerList", + "traits": { + "smithy.api#documentation": "

The authorized token issuer list for the Amazon Redshift IAM Identity Center application.

" + } + }, + "ServiceIntegrations": { + "target": "com.amazonaws.redshift#ServiceIntegrationList", + "traits": { + "smithy.api#documentation": "

A list of service integrations for the Redshift IAM Identity Center application.

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

Contains properties for the Redshift IDC application.

" + } + }, + "com.amazonaws.redshift#RedshiftIdcApplicationAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "RedshiftIdcApplicationAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The application you attempted to add already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshift#RedshiftIdcApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#RedshiftIdcApplication" + } + }, + "com.amazonaws.redshift#RedshiftIdcApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$" + } + }, + "com.amazonaws.redshift#RedshiftIdcApplicationNotExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "RedshiftIdcApplicationNotExists", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The application you attempted to find doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.redshift#RedshiftIdcApplicationQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "RedshiftIdcApplicationQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The maximum number of Redshift IAM Identity Center applications was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.redshift#RedshiftServiceVersion20121201": { "type": "service", "version": "2012-12-01", @@ -12932,6 +13482,9 @@ { "target": "com.amazonaws.redshift#CreateHsmConfiguration" }, + { + "target": "com.amazonaws.redshift#CreateRedshiftIdcApplication" + }, { "target": "com.amazonaws.redshift#CreateScheduledAction" }, @@ -12986,6 +13539,9 @@ { "target": "com.amazonaws.redshift#DeletePartner" }, + { + "target": "com.amazonaws.redshift#DeleteRedshiftIdcApplication" + }, { "target": "com.amazonaws.redshift#DeleteResourcePolicy" }, @@ -13088,6 +13644,9 @@ { "target": "com.amazonaws.redshift#DescribePartners" }, + { + "target": "com.amazonaws.redshift#DescribeRedshiftIdcApplications" + }, { "target": "com.amazonaws.redshift#DescribeReservedNodeExchangeStatus" }, @@ -13193,6 +13752,9 @@ { "target": "com.amazonaws.redshift#ModifyEventSubscription" }, + { + "target": "com.amazonaws.redshift#ModifyRedshiftIdcApplication" + }, { "target": "com.amazonaws.redshift#ModifyScheduledAction" }, @@ -16465,6 +17027,43 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.redshift#ServiceAuthorization": { + "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.redshift#ServiceIntegrationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#ServiceIntegrationsUnion" + } + }, + "com.amazonaws.redshift#ServiceIntegrationsUnion": { + "type": "union", + "members": { + "LakeFormation": { + "target": "com.amazonaws.redshift#LakeFormationServiceIntegrations", + "traits": { + "smithy.api#documentation": "

A list of scopes set up for Lake Formation integration.

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

A list of service integrations.

" + } + }, "com.amazonaws.redshift#Snapshot": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/s3.json b/codegen/sdk-codegen/aws-models/s3.json index f119125dd9e..fadf503813f 100644 --- a/codegen/sdk-codegen/aws-models/s3.json +++ b/codegen/sdk-codegen/aws-models/s3.json @@ -38,7 +38,6 @@ "DaysAfterInitiation": { "target": "com.amazonaws.s3#DaysAfterInitiation", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies the number of days after which Amazon S3 aborts an incomplete multipart\n upload.

" } } @@ -206,10 +205,7 @@ "type": "string" }, "com.amazonaws.s3#AllowQuotedRecordDelimiter": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#AllowedHeader": { "type": "string" @@ -650,7 +646,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -861,7 +856,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -875,7 +869,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -889,7 +882,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -903,7 +895,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -960,7 +951,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -980,7 +972,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -994,7 +987,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1008,7 +1000,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1065,7 +1056,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1085,21 +1077,24 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Unrecognized hardware type: \"Expected hardware type o or e but got {hardwareType}\"", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`.", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1112,7 +1107,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1167,7 +1161,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1181,7 +1174,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1195,7 +1187,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1361,7 +1352,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1381,7 +1371,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1599,7 +1590,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1619,7 +1609,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1837,7 +1828,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1857,7 +1847,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2075,7 +2066,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2095,7 +2085,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2438,7 +2429,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2486,7 +2476,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2573,7 +2564,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2621,7 +2611,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2959,7 +2950,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3007,7 +2997,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3225,7 +3216,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3273,7 +3263,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3357,16 +3348,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid region: region was not a valid DNS name.", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3448,7 +3442,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3462,7 +3455,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3476,7 +3468,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3496,16 +3487,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid region: region was not a valid DNS name.", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3528,7 +3522,6 @@ "assign": "bucketArn" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3557,7 +3550,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3577,7 +3569,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3591,7 +3582,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3620,7 +3610,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3675,7 +3664,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3722,7 +3710,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3785,7 +3772,6 @@ "assign": "bucketPartition" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3799,7 +3785,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3827,7 +3812,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3847,7 +3831,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3888,7 +3871,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3902,7 +3884,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3986,67 +3967,78 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `{accessPointName}`", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN (`{Bucket}`) has `{bucketPartition#name}`", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`.", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: bucket ARN is missing a region", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Object Lambda ARNs only support `accesspoint` arn types, but found: `{arnType}`", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -4060,7 +4052,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4089,7 +4080,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4114,7 +4104,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4128,7 +4117,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4153,7 +4141,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4200,7 +4187,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4263,7 +4249,6 @@ "assign": "bucketPartition" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4277,7 +4262,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4297,7 +4281,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4317,7 +4300,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4337,7 +4319,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4357,7 +4338,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4371,7 +4351,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4590,57 +4569,68 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `{accessPointName}`", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the S3 service, found: {bucketArn#service}", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN (`{Bucket}`) has `{bucketPartition#name}`", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`.", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -4654,7 +4644,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4728,7 +4717,6 @@ "assign": "mrapPartition" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4756,7 +4744,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -4778,30 +4765,35 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Client was configured for partition `{mrapPartition#name}` but bucket referred to partition `{bucketArn#partition}`", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Access Point Name", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -4821,7 +4813,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4901,7 +4892,6 @@ "assign": "outpostId" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4915,7 +4905,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4978,7 +4967,6 @@ "assign": "bucketPartition" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -4992,7 +4980,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5020,7 +5007,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5040,7 +5026,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5060,7 +5045,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5075,7 +5059,6 @@ "assign": "outpostType" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5090,7 +5073,6 @@ "assign": "accessPointName" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5104,7 +5086,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5160,81 +5141,94 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Expected an outpost type `accesspoint`, found {outpostType}", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: expected an access point name", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Expected a 4-component resource", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN (`{Bucket}`) has `{bucketPartition#name}`", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The outpost Id may only contain a-z, A-Z, 0-9 and `-`. Found: `{outpostId}`", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The Outpost Id was not set", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Unrecognized format: {Bucket} (type: {arnType})", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -5316,7 +5310,6 @@ "assign": "uri_encoded_bucket" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5330,7 +5323,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5344,7 +5336,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -5462,7 +5453,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -5482,7 +5472,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -5673,7 +5664,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -5693,7 +5683,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -5884,7 +5875,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -5904,7 +5894,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -6103,7 +6094,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6151,7 +6141,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -6346,7 +6337,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6394,7 +6384,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -6469,18 +6460,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Path-style addressing cannot be used with S3 Accelerate", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -6502,7 +6497,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6516,7 +6510,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6530,7 +6523,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6644,16 +6636,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid region: region was not a valid DNS name.", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -6671,7 +6666,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6685,7 +6679,6 @@ "assign": "partitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6699,7 +6692,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -6817,7 +6809,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -6837,7 +6828,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -7028,7 +7020,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -7048,7 +7039,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -7239,7 +7231,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -7259,7 +7250,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -7458,7 +7450,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -7506,7 +7497,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -7701,7 +7693,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -7749,7 +7740,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -7824,18 +7816,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid region: region was not a valid DNS name.", "type": "error" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -15780,10 +15776,7 @@ } }, "com.amazonaws.s3#BucketKeyEnabled": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#BucketLifecycleConfiguration": { "type": "structure", @@ -16039,28 +16032,16 @@ } }, "com.amazonaws.s3#BypassGovernanceRetention": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#BytesProcessed": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#BytesReturned": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#BytesScanned": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#CORSConfiguration": { "type": "structure", @@ -16125,7 +16106,6 @@ "MaxAgeSeconds": { "target": "com.amazonaws.s3#MaxAgeSeconds", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The time in seconds that your browser is to cache the preflight response for the\n specified resource.

" } } @@ -16182,7 +16162,6 @@ "AllowQuotedRecordDelimiter": { "target": "com.amazonaws.s3#AllowQuotedRecordDelimiter", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies that CSV field values may contain quoted record delimiters and such records\n should be allowed. Default value is FALSE. Setting this value to TRUE may lower\n performance.

" } } @@ -16447,7 +16426,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -16621,7 +16599,6 @@ "PartNumber": { "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Part number that identifies the part. This is a positive integer between 1 and\n 10,000.

" } } @@ -16680,10 +16657,7 @@ } }, "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#ContentDisposition": { "type": "string" @@ -16695,10 +16669,7 @@ "type": "string" }, "com.amazonaws.s3#ContentLength": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#ContentMD5": { "type": "string" @@ -16824,7 +16795,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -17062,7 +17032,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS.

\n

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3\n Bucket Key.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -17285,13 +17254,16 @@ "smithy.api#documentation": "

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming\n rules.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. To constrain the bucket creation to a\n specific Region, you can use \n LocationConstraint\n condition key. You might choose a Region to\n optimize latency, minimize costs, or address regulatory requirements. For example, if you\n reside in Europe, you will probably find it advantageous to create buckets in the Europe\n (Ireland) Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature\n calculations in Signature Version 4 must use us-east-1 as the Region, even\n if the location constraint in the request specifies another Region where the bucket is\n to be created. If you create a bucket in a Region other than US East (N. Virginia), your\n application must be able to handle 307 redirect. For more information, see Virtual hosting of\n buckets.

\n \n
\n
Permissions
\n
\n

In addition to s3:CreateBucket, the following permissions are\n required when your CreateBucket request includes specific\n headers:

\n
    \n
  • \n

    \n Access control lists (ACLs) - If your\n CreateBucket request specifies access control list (ACL)\n permissions and the ACL is public-read, public-read-write,\n authenticated-read, or if you specify access permissions explicitly through\n any other ACL, both s3:CreateBucket and\n s3:PutBucketAcl permissions are needed. If the ACL for the\n CreateBucket request is private or if the request doesn't\n specify any ACLs, only s3:CreateBucket permission is needed.\n

    \n
    • \n
  • \n

    \n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.

    \n
    • \n
  • \n

    \n S3 Object Ownership - If your\n CreateBucket request includes the\n x-amz-object-ownership header, then the\n s3:PutBucketOwnershipControls permission is required. By\n default, ObjectOwnership is set to\n BucketOWnerEnforced and ACLs are disabled. We recommend\n keeping ACLs disabled, except in uncommon use cases where you must control\n access for each object individually. If you want to change the\n ObjectOwnership setting, you can use the\n x-amz-object-ownership header in your\n CreateBucket request to set the ObjectOwnership\n setting of your choice. For more information about S3 Object Ownership, see\n Controlling\n object ownership in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n S3 Block Public Access - If your\n specific use case requires granting public access to your S3 resources, you\n can disable Block Public Access. You can create a new bucket with Block\n Public Access enabled, then separately call the \n DeletePublicAccessBlock\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock permission. By default, all\n Block Public Access settings are enabled for new buckets. To avoid\n inadvertent exposure of your resources, we recommend keeping the S3 Block\n Public Access settings enabled. For more information about S3 Block Public\n Access, see Blocking\n public access to your Amazon S3 storage in the\n Amazon S3 User Guide.

    \n
    • \n
\n
\n
\n \n

If your CreateBucket request sets BucketOwnerEnforced for\n Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external\n Amazon Web Services account, your request fails with a 400 error and returns the\n InvalidBucketAcLWithObjectOwnership error code. For more information,\n see Setting Object\n Ownership on an existing bucket in the Amazon S3 User Guide.\n

\n \n

The following operations are related to CreateBucket:

\n ", "smithy.api#examples": [ { - "title": "To create a bucket ", - "documentation": "The following example creates a bucket.", + "title": "To create a bucket in a specific region", + "documentation": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", "input": { - "Bucket": "examplebucket" + "Bucket": "examplebucket", + "CreateBucketConfiguration": { + "LocationConstraint": "eu-west-1" + } }, "output": { - "Location": "/examplebucket" + "Location": "http://examplebucket..s3.amazonaws.com/" } } ], @@ -17403,7 +17375,6 @@ "ObjectLockEnabledForBucket": { "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

", "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" } @@ -17525,7 +17496,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -17714,7 +17684,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS.

\n

Specifying this header with an object action doesn’t affect bucket-level settings for S3\n Bucket Key.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -17782,16 +17751,10 @@ } }, "com.amazonaws.s3#Days": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#DaysAfterInitiation": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#DefaultRetention": { "type": "structure", @@ -17805,14 +17768,12 @@ "Days": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of days that you want to specify for the default retention period. Must be\n used with Mode.

" } }, "Years": { "target": "com.amazonaws.s3#Years", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of years that you want to specify for the default retention period. Must be\n used with Mode.

" } } @@ -17836,7 +17797,6 @@ "Quiet": { "target": "com.amazonaws.s3#Quiet", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Element to enable quiet mode for the request. When you add this element, you must set\n its value to true.

" } } @@ -18493,10 +18453,7 @@ } }, "com.amazonaws.s3#DeleteMarker": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#DeleteMarkerEntry": { "type": "structure", @@ -18522,7 +18479,6 @@ "IsLatest": { "target": "com.amazonaws.s3#IsLatest", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" } }, @@ -18610,7 +18566,6 @@ "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the specified object version that was permanently deleted was (true) or was\n not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or\n not (false) the current version of the object is a delete marker.

", "smithy.api#httpHeader": "x-amz-delete-marker" } @@ -18678,7 +18633,6 @@ "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation. To use this header, you must have the\n s3:BypassGovernanceRetention permission.

", "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } @@ -18707,15 +18661,14 @@ "smithy.api#documentation": "

Removes the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.

\n

To use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.

\n

To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.

\n

The following operations are related to DeleteObjectTagging:

\n ", "smithy.api#examples": [ { - "title": "To remove tag set from an object version", - "documentation": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", + "title": "To remove tag set from an object", + "documentation": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "Key": "HappyFace.jpg" }, "output": { - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "VersionId": "null" } } ], @@ -18906,7 +18859,6 @@ "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. To use this header, you must have the\n s3:BypassGovernanceRetention permission.

", "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } @@ -18991,7 +18943,6 @@ "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the specified object version that was permanently deleted was (true) or was\n not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or\n not (false) the current version of the object is a delete marker.

" } }, @@ -19079,10 +19030,7 @@ "type": "string" }, "com.amazonaws.s3#EnableRequestProgress": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#EncodingType": { "type": "enum", @@ -19140,10 +19088,7 @@ } }, "com.amazonaws.s3#End": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#EndEvent": { "type": "structure", @@ -19447,10 +19392,7 @@ } }, "com.amazonaws.s3#ExpiredObjectDeleteMarker": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#Expires": { "type": "timestamp" @@ -19479,10 +19421,7 @@ } }, "com.amazonaws.s3#FetchOwner": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#FieldDelimiter": { "type": "string" @@ -21143,7 +21082,6 @@ "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not\n (false) a delete marker. If false, this response header does\n not appear in the response.

", "smithy.api#httpHeader": "x-amz-delete-marker" } @@ -21195,7 +21133,6 @@ "ObjectSize": { "target": "com.amazonaws.s3#ObjectSize", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The size of the object in bytes.

" } } @@ -21210,7 +21147,6 @@ "TotalPartsCount": { "target": "com.amazonaws.s3#PartsCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The total number of parts.

", "smithy.api#xmlName": "PartsCount" } @@ -21230,14 +21166,12 @@ "MaxParts": { "target": "com.amazonaws.s3#MaxParts", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of parts allowed in the response.

" } }, "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the returned list of parts is truncated. A value of true\n indicates that the list was truncated. A list can be truncated if the number of parts\n exceeds the limit returned in the MaxParts element.

" } }, @@ -21286,7 +21220,6 @@ "MaxParts": { "target": "com.amazonaws.s3#MaxParts", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Sets the maximum number of parts to return.

", "smithy.api#httpHeader": "x-amz-max-parts" } @@ -21496,7 +21429,6 @@ "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

", "smithy.api#httpHeader": "x-amz-delete-marker" } @@ -21532,7 +21464,6 @@ "ContentLength": { "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Size of the body in bytes.

", "smithy.api#httpHeader": "Content-Length" } @@ -21575,7 +21506,6 @@ "MissingMeta": { "target": "com.amazonaws.s3#MissingMeta", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

This is set to the number of metadata entries not returned in x-amz-meta\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.

", "smithy.api#httpHeader": "x-amz-missing-meta" } @@ -21681,7 +21611,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -21709,7 +21638,6 @@ "PartsCount": { "target": "com.amazonaws.s3#PartsCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The count of parts this object has. This value is only returned if you specify\n partNumber in your request and the object was uploaded as a multipart\n upload.

", "smithy.api#httpHeader": "x-amz-mp-parts-count" } @@ -21717,7 +21645,6 @@ "TagCount": { "target": "com.amazonaws.s3#TagCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of tags, if any, on the object.

", "smithy.api#httpHeader": "x-amz-tagging-count" } @@ -21884,7 +21811,6 @@ "PartNumber": { "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' GET request for the part specified. Useful for downloading\n just a part of an object.

", "smithy.api#httpQuery": "partNumber" } @@ -21909,10 +21835,7 @@ } }, "com.amazonaws.s3#GetObjectResponseStatusCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#GetObjectRetention": { "type": "operation", @@ -22500,7 +22423,6 @@ "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

", "smithy.api#httpHeader": "x-amz-delete-marker" } @@ -22543,7 +22465,6 @@ "ContentLength": { "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Size of the body in bytes.

", "smithy.api#httpHeader": "Content-Length" } @@ -22586,7 +22507,6 @@ "MissingMeta": { "target": "com.amazonaws.s3#MissingMeta", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

This is set to the number of metadata entries not returned in x-amz-meta\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.

", "smithy.api#httpHeader": "x-amz-missing-meta" } @@ -22685,7 +22605,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -22713,7 +22632,6 @@ "PartsCount": { "target": "com.amazonaws.s3#PartsCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The count of parts this object has. This value is only returned if you specify\n partNumber in your request and the object was uploaded as a multipart\n upload.

", "smithy.api#httpHeader": "x-amz-mp-parts-count" } @@ -22838,7 +22756,6 @@ "PartNumber": { "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about\n the size of the part and the number of parts in this object.

", "smithy.api#httpQuery": "partNumber" } @@ -23039,10 +22956,7 @@ } }, "com.amazonaws.s3#IntelligentTieringDays": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#IntelligentTieringFilter": { "type": "structure", @@ -23115,7 +23029,6 @@ "IsEnabled": { "target": "com.amazonaws.s3#IsEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the inventory is enabled or disabled. If set to True, an\n inventory list is generated. If set to False, no inventory list is\n generated.

", "smithy.api#required": {} } @@ -23436,34 +23349,19 @@ } }, "com.amazonaws.s3#IsEnabled": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#IsLatest": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#IsPublic": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#IsRestoreInProgress": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#IsTruncated": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#JSONInput": { "type": "structure", @@ -23514,10 +23412,7 @@ "type": "string" }, "com.amazonaws.s3#KeyCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#KeyMarker": { "type": "string" @@ -23580,14 +23475,12 @@ "Days": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n must be a non-zero positive integer.

" } }, "ExpiredObjectDeleteMarker": { "target": "com.amazonaws.s3#ExpiredObjectDeleteMarker", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired; if set to false the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

" } } @@ -23678,14 +23571,12 @@ "ObjectSizeGreaterThan": { "target": "com.amazonaws.s3#ObjectSizeGreaterThanBytes", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Minimum object size to which the rule applies.

" } }, "ObjectSizeLessThan": { "target": "com.amazonaws.s3#ObjectSizeLessThanBytes", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum object size to which the rule applies.

" } } @@ -23758,7 +23649,6 @@ "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" } }, @@ -23844,7 +23734,6 @@ "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the\n NextContinuationToken will be provided for a subsequent request.

" } }, @@ -23936,7 +23825,6 @@ "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Tells whether the returned list of inventory configurations is complete. A value of true\n indicates that the list is not complete and the NextContinuationToken is provided for a\n subsequent request.

" } }, @@ -24008,7 +23896,6 @@ "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the returned list of metrics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" } }, @@ -24145,47 +24032,6 @@ }, "traits": { "smithy.api#documentation": "

This action lists in-progress multipart uploads. An in-progress multipart upload is a\n multipart upload that has been initiated using the Initiate Multipart Upload request, but\n has not yet been completed or aborted.

\n

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart\n uploads is the maximum number of uploads a response can include, which is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads parameter in the response. If additional multipart uploads\n satisfy the list criteria, the response will contain an IsTruncated element\n with the value true. To list the additional multipart uploads, use the\n key-marker and upload-id-marker request parameters.

\n

In the response, the uploads are sorted by key. If your application has initiated more\n than one multipart upload using the same object key, then uploads in the response are first\n sorted by key. Additionally, uploads are sorted in ascending order within each key by the\n upload initiation time.

\n

For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.

\n

For information on permissions required to use the multipart upload API, see Multipart Upload\n and Permissions.

\n

The following operations are related to ListMultipartUploads:

\n ", - "smithy.api#examples": [ - { - "title": "To list in-progress multipart uploads on a bucket", - "documentation": "The following example lists in-progress multipart uploads on a specific bucket.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "Uploads": [ - { - "Initiator": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Initiated": "2014-05-01T05:40:58.000Z", - "UploadId": "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--", - "StorageClass": "STANDARD", - "Key": "JavaFile", - "Owner": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - } - }, - { - "Initiator": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Initiated": "2014-05-01T05:41:27.000Z", - "UploadId": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", - "StorageClass": "STANDARD", - "Key": "JavaFile", - "Owner": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - } - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?uploads", @@ -24241,14 +24087,12 @@ "MaxUploads": { "target": "com.amazonaws.s3#MaxUploads", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of multipart uploads that could have been included in the\n response.

" } }, "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the returned list of multipart uploads is truncated. A value of true\n indicates that the list was truncated. The list can be truncated if the number of multipart\n uploads exceeds the limit allowed or specified by max uploads.

" } }, @@ -24322,7 +24166,6 @@ "MaxUploads": { "target": "com.amazonaws.s3#MaxUploads", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response\n body. 1,000 is the maximum number of uploads that can be returned in a response.

", "smithy.api#httpQuery": "max-uploads" } @@ -24422,7 +24265,6 @@ "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request by\n using the NextKeyMarker and NextVersionIdMarker response\n parameters as a starting place in another request to return the rest of the results.

" } }, @@ -24487,7 +24329,6 @@ "MaxKeys": { "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies the maximum number of objects to return.

" } }, @@ -24553,7 +24394,6 @@ "MaxKeys": { "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n If additional keys satisfy the search criteria, but were not returned because\n max-keys was exceeded, the response contains\n true. To return the additional keys,\n see key-marker and version-id-marker.

", "smithy.api#httpQuery": "max-keys" } @@ -24625,7 +24465,6 @@ "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria.

" } }, @@ -24669,7 +24508,6 @@ "MaxKeys": { "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of keys returned in the response body.

" } }, @@ -24735,7 +24573,6 @@ "MaxKeys": { "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n

", "smithy.api#httpQuery": "max-keys" } @@ -24806,7 +24643,6 @@ "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Set to false if all of the results were returned. Set to true\n if more keys are available to return. If the number of results exceeds that specified by\n MaxKeys, all of the results might not be returned.

" } }, @@ -24838,7 +24674,6 @@ "MaxKeys": { "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

" } }, @@ -24858,7 +24693,6 @@ "KeyCount": { "target": "com.amazonaws.s3#KeyCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

\n KeyCount is the number of keys returned with this request.\n KeyCount will always be less than or equal to the MaxKeys\n field. For example, if you ask for 50 keys, your result will include 50 keys or\n fewer.

" } }, @@ -24923,7 +24757,6 @@ "MaxKeys": { "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

", "smithy.api#httpQuery": "max-keys" } @@ -24945,7 +24778,6 @@ "FetchOwner": { "target": "com.amazonaws.s3#FetchOwner", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

The owner field is not present in ListObjectsV2 by default. If you want to\n return the owner field with each key in the result, then set the FetchOwner\n field to true.

", "smithy.api#httpQuery": "fetch-owner" } @@ -25056,14 +24888,12 @@ "MaxParts": { "target": "com.amazonaws.s3#MaxParts", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of parts that were allowed in the response.

" } }, "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the returned list of parts is truncated. A true value indicates that\n the list was truncated. A list can be truncated if the number of parts exceeds the limit\n returned in the MaxParts element.

" } }, @@ -25136,7 +24966,6 @@ "MaxParts": { "target": "com.amazonaws.s3#MaxParts", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Sets the maximum number of parts to return.

", "smithy.api#httpQuery": "max-parts" } @@ -25270,28 +25099,16 @@ "type": "string" }, "com.amazonaws.s3#MaxAgeSeconds": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#MaxKeys": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#MaxParts": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#MaxUploads": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#Message": { "type": "string" @@ -25477,16 +25294,10 @@ } }, "com.amazonaws.s3#Minutes": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#MissingMeta": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#MultipartUpload": { "type": "structure", @@ -25595,14 +25406,12 @@ "NoncurrentDays": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. The value must be a non-zero positive integer. For information about the\n noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the\n Amazon S3 User Guide.

" } }, "NewerNoncurrentVersions": { "target": "com.amazonaws.s3#VersionCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more\n recent noncurrent versions, Amazon S3 will take the associated action. For more information\n about noncurrent versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.

" } } @@ -25617,7 +25426,6 @@ "NoncurrentDays": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n Amazon S3 User Guide.

" } }, @@ -25630,7 +25438,6 @@ "NewerNoncurrentVersions": { "target": "com.amazonaws.s3#VersionCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more\n recent noncurrent versions, Amazon S3 will take the associated action. For more information\n about noncurrent versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.

" } } @@ -25742,7 +25549,6 @@ "Size": { "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Size in bytes of the object

" } }, @@ -25938,10 +25744,7 @@ } }, "com.amazonaws.s3#ObjectLockEnabledForBucket": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#ObjectLockLegalHold": { "type": "structure", @@ -26091,14 +25894,12 @@ "PartNumber": { "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The part number identifying the part. This value is a positive integer between 1 and\n 10,000.

" } }, "Size": { "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The size of the uploaded part in bytes.

" } }, @@ -26132,22 +25933,13 @@ } }, "com.amazonaws.s3#ObjectSize": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#ObjectSizeGreaterThanBytes": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#ObjectSizeLessThanBytes": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#ObjectStorageClass": { "type": "enum", @@ -26233,7 +26025,6 @@ "Size": { "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Size in bytes of the object.

" } }, @@ -26258,7 +26049,6 @@ "IsLatest": { "target": "com.amazonaws.s3#IsLatest", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" } }, @@ -26437,7 +26227,6 @@ "PartNumber": { "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Part number identifying the part. This is a positive integer between 1 and\n 10,000.

" } }, @@ -26456,7 +26245,6 @@ "Size": { "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Size in bytes of the uploaded part data.

" } }, @@ -26490,10 +26278,7 @@ } }, "com.amazonaws.s3#PartNumber": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#PartNumberMarker": { "type": "string" @@ -26505,10 +26290,7 @@ } }, "com.amazonaws.s3#PartsCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#PartsList": { "type": "list", @@ -26577,7 +26359,6 @@ "IsPublic": { "target": "com.amazonaws.s3#IsPublic", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

The policy status for this bucket. TRUE indicates that this bucket is\n public. FALSE indicates that the bucket is not public.

", "smithy.api#xmlName": "IsPublic" } @@ -26591,10 +26372,7 @@ "type": "string" }, "com.amazonaws.s3#Priority": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#Progress": { "type": "structure", @@ -26602,21 +26380,18 @@ "BytesScanned": { "target": "com.amazonaws.s3#BytesScanned", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The current number of object bytes scanned.

" } }, "BytesProcessed": { "target": "com.amazonaws.s3#BytesProcessed", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The current number of uncompressed object bytes processed.

" } }, "BytesReturned": { "target": "com.amazonaws.s3#BytesReturned", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The current number of bytes of records payload data returned.

" } } @@ -26663,7 +26438,6 @@ "BlockPublicAcls": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket\n and objects in this bucket. Setting this element to TRUE causes the following\n behavior:

\n
    \n
  • \n

    PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is\n public.

    \n
    • \n
  • \n

    PUT Object calls fail if the request includes a public ACL.

    \n
    • \n
  • \n

    PUT Bucket calls fail if the request includes a public ACL.

    \n
    • \n
\n

Enabling this setting doesn't affect existing policies or ACLs.

", "smithy.api#xmlName": "BlockPublicAcls" } @@ -26671,7 +26445,6 @@ "IgnorePublicAcls": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on\n this bucket and objects in this bucket.

\n

Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.

", "smithy.api#xmlName": "IgnorePublicAcls" } @@ -26679,7 +26452,6 @@ "BlockPublicPolicy": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this\n element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the\n specified bucket policy allows public access.

\n

Enabling this setting doesn't affect existing bucket policies.

", "smithy.api#xmlName": "BlockPublicPolicy" } @@ -26687,7 +26459,6 @@ "RestrictPublicBuckets": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has\n a public policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

", "smithy.api#xmlName": "RestrictPublicBuckets" } @@ -27549,7 +27320,6 @@ "SkipDestinationValidation": { "target": "com.amazonaws.s3#SkipValidation", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Skips validation of Amazon SQS, Amazon SNS, and Lambda\n destinations. True or false value.

", "smithy.api#httpHeader": "x-amz-skip-destination-validation" } @@ -27683,7 +27453,6 @@ "ConfirmRemoveSelfBucketAccess": { "target": "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Set this parameter to true to confirm that you want to remove your permissions to change\n this bucket policy in the future.

", "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" } @@ -28172,19 +27941,16 @@ "smithy.api#documentation": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.

\n \n

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.

\n \n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock.

\n

To ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.

\n \n
    \n
  • \n

    To successfully complete the PutObject request, you must have the\n s3:PutObject in your IAM permissions.

    \n
    • \n
  • \n

    To successfully change the objects acl of your PutObject request,\n you must have the s3:PutObjectAcl in your IAM permissions.

    \n
    • \n
  • \n

    To successfully set the tag-set with your PutObject request, you\n must have the s3:PutObjectTagging in your IAM permissions.

    \n
    • \n
  • \n

    The Content-MD5 header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information about Amazon S3 Object Lock, see Amazon S3 Object Lock\n Overview in the Amazon S3 User Guide.

    \n
    • \n
\n \n

You have four mutually exclusive options to protect data using server-side encryption in\n Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the\n encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or\n DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side\n encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to\n encrypt data at rest by using server-side encryption with other key options. For more\n information, see Using Server-Side\n Encryption.

\n

When adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API.

\n

If the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code AccessControlListNotSupported.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.

\n \n

If your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.

\n \n

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.

\n

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.

\n

For more information about related Amazon S3 APIs, see the following:

\n ", "smithy.api#examples": [ { - "title": "To upload an object and specify server-side encryption and object tags", - "documentation": "The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "title": "To upload an object", + "documentation": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", "input": { - "Body": "filetoupload", + "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "exampleobject", - "ServerSideEncryption": "AES256", - "Tagging": "key1=value1&key2=value2" + "Key": "HappyFace.jpg" }, "output": { - "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256" + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" } } ], @@ -28650,7 +28416,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -28726,7 +28491,6 @@ "ContentLength": { "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.

", "smithy.api#httpHeader": "Content-Length" } @@ -28889,7 +28653,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS.

\n

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3\n Bucket Key.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -29021,7 +28784,6 @@ "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether this action should bypass Governance-mode restrictions.

", "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } @@ -29196,7 +28958,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock configurations are different between the bucket and\n the account, S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n

The following operations are related to PutPublicAccessBlock:

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

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n

The following operations are related to PutPublicAccessBlock:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?publicAccessBlock", @@ -29294,10 +29056,7 @@ } }, "com.amazonaws.s3#Quiet": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#QuoteCharacter": { "type": "string" @@ -29479,7 +29238,6 @@ "Priority": { "target": "com.amazonaws.s3#Priority", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The priority indicates which rule has precedence whenever two or more replication rules\n conflict. Amazon S3 will attempt to replicate objects according to all replication rules.\n However, if there are two or more rules with the same destination bucket, then objects will\n be replicated according to the rule with the highest priority. The higher the number, the\n higher the priority.

\n

For more information, see Replication in the\n Amazon S3 User Guide.

" } }, @@ -29678,7 +29436,6 @@ "Minutes": { "target": "com.amazonaws.s3#Minutes", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Contains an integer specifying time in minutes.

\n

Valid value: 15

" } } @@ -29736,7 +29493,6 @@ "Enabled": { "target": "com.amazonaws.s3#EnableRequestProgress", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,\n FALSE. Default value: FALSE.

" } } @@ -29911,7 +29667,6 @@ "Days": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Lifetime of the active copy in days. Do not use with restores that specify\n OutputLocation.

\n

The Days element is required for regular restores, and must not be provided for select\n requests.

" } }, @@ -29973,7 +29728,6 @@ "IsRestoreInProgress": { "target": "com.amazonaws.s3#IsRestoreInProgress", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the object is currently being restored. If the object restoration is\n in progress, the header returns the value TRUE. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"true\"\n

\n

If the object restoration has completed, the header returns the value\n FALSE. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"false\",\n RestoreExpiryDate=\"2012-12-21T00:00:00.000Z\"\n

\n

If the object hasn't been restored, there is no header response.

" } }, @@ -30145,14 +29899,12 @@ "Start": { "target": "com.amazonaws.s3#Start", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies the start of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is 0. If only start is supplied, it\n means scan from that point to the end of the file. For example,\n 50 means scan\n from byte 50 until the end of the file.

" } }, "End": { "target": "com.amazonaws.s3#End", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Specifies the end of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is one less than the size of the object being\n queried. If only the End parameter is supplied, it is interpreted to mean scan the last N\n bytes of the file. For example,\n 50 means scan the\n last 50 bytes.

" } } @@ -30437,7 +30189,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS\n (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the\n BucketKeyEnabled element to true causes Amazon S3 to use an S3\n Bucket Key. By default, S3 Bucket Key is not enabled.

\n

For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.

" } } @@ -30453,22 +30204,13 @@ } }, "com.amazonaws.s3#Setting": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#Size": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#SkipValidation": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.s3#SourceSelectionCriteria": { "type": "structure", @@ -30523,10 +30265,7 @@ } }, "com.amazonaws.s3#Start": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.s3#StartAfter": { "type": "string" @@ -30537,21 +30276,18 @@ "BytesScanned": { "target": "com.amazonaws.s3#BytesScanned", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The total number of object bytes scanned.

" } }, "BytesProcessed": { "target": "com.amazonaws.s3#BytesProcessed", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The total number of uncompressed object bytes processed.

" } }, "BytesReturned": { "target": "com.amazonaws.s3#BytesReturned", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The total number of bytes of records payload data returned.

" } } @@ -30719,10 +30455,7 @@ } }, "com.amazonaws.s3#TagCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#TagSet": { "type": "list", @@ -30836,7 +30569,6 @@ "Days": { "target": "com.amazonaws.s3#IntelligentTieringDays", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of consecutive days of no access after which an object will be eligible to be\n transitioned to the corresponding tier. The minimum number of days specified for\n Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least\n 180 days. The maximum can be up to 2 years (730 days).

", "smithy.api#required": {} } @@ -30914,7 +30646,6 @@ "Days": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Indicates the number of days after creation when objects are transitioned to the\n specified storage class. The value must be a positive integer.

" } }, @@ -31090,7 +30821,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -31174,7 +30904,6 @@ "PartNumber": { "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Part number of part being copied. This is a positive integer between 1 and\n 10,000.

", "smithy.api#httpQuery": "partNumber", "smithy.api#required": {} @@ -31324,7 +31053,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } @@ -31365,7 +31093,6 @@ "ContentLength": { "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically.

", "smithy.api#httpHeader": "Content-Length" } @@ -31423,7 +31150,6 @@ "PartNumber": { "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Part number of part being uploaded. This is a positive integer between 1 and\n 10,000.

", "smithy.api#httpQuery": "partNumber", "smithy.api#required": {} @@ -31489,10 +31215,7 @@ "type": "string" }, "com.amazonaws.s3#VersionCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.s3#VersionIdMarker": { "type": "string" @@ -31613,7 +31336,6 @@ "StatusCode": { "target": "com.amazonaws.s3#GetObjectResponseStatusCode", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The integer status code for an HTTP response of a corresponding GetObject\n request. The following is a list of status codes.

\n
    \n
  • \n

    \n 200 - OK\n

    \n
    • \n
  • \n

    \n 206 - Partial Content\n

    \n
    • \n
  • \n

    \n 304 - Not Modified\n

    \n
    • \n
  • \n

    \n 400 - Bad Request\n

    \n
    • \n
  • \n

    \n 401 - Unauthorized\n

    \n
    • \n
  • \n

    \n 403 - Forbidden\n

    \n
    • \n
  • \n

    \n 404 - Not Found\n

    \n
    • \n
  • \n

    \n 405 - Method Not Allowed\n

    \n
    • \n
  • \n

    \n 409 - Conflict\n

    \n
    • \n
  • \n

    \n 411 - Length Required\n

    \n
    • \n
  • \n

    \n 412 - Precondition Failed\n

    \n
    • \n
  • \n

    \n 416 - Range Not Satisfiable\n

    \n
    • \n
  • \n

    \n 500 - Internal Server Error\n

    \n
    • \n
  • \n

    \n 503 - Service Unavailable\n

    \n
    • \n
", "smithy.api#httpHeader": "x-amz-fwd-status" } @@ -31670,7 +31392,6 @@ "ContentLength": { "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The size of the content body in bytes.

", "smithy.api#httpHeader": "Content-Length" } @@ -31720,7 +31441,6 @@ "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether an object stored in Amazon S3 is (true) or is not\n (false) a delete marker.

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-delete-marker" } @@ -31756,7 +31476,6 @@ "MissingMeta": { "target": "com.amazonaws.s3#MissingMeta", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Set to the number of metadata entries not returned in x-amz-meta headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-missing-meta" } @@ -31792,7 +31511,6 @@ "PartsCount": { "target": "com.amazonaws.s3#PartsCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The count of parts this object has.

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-mp-parts-count" } @@ -31855,7 +31573,6 @@ "TagCount": { "target": "com.amazonaws.s3#TagCount", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The number of tags, if any, on the object.

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-tagging-count" } @@ -31870,7 +31587,6 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side\n encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled" } @@ -31881,10 +31597,7 @@ } }, "com.amazonaws.s3#Years": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" } } } diff --git a/codegen/sdk-codegen/aws-models/sso-admin.json b/codegen/sdk-codegen/aws-models/sso-admin.json index 9b780f4f751..fcca94811fd 100644 --- a/codegen/sdk-codegen/aws-models/sso-admin.json +++ b/codegen/sdk-codegen/aws-models/sso-admin.json @@ -834,12 +834,12 @@ "RedirectUris": { "target": "com.amazonaws.ssoadmin#RedirectUris", "traits": { - "smithy.api#documentation": "

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

A list of URIs that are valid locations to redirect a user's browser after the user is authorized.

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

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the OAuth 2.0 Authorization Code Grant.

" } }, "com.amazonaws.ssoadmin#AuthorizedTokenIssuer": { @@ -3628,18 +3628,30 @@ "AuthorizationCode": { "target": "com.amazonaws.ssoadmin#AuthorizationCodeGrant", "traits": { - "smithy.api#documentation": "

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

Configuration options for the authorization_code grant type.

" } }, "JwtBearer": { "target": "com.amazonaws.ssoadmin#JwtBearerGrant", "traits": { - "smithy.api#documentation": "

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer grant type.

" + } + }, + "RefreshToken": { + "target": "com.amazonaws.ssoadmin#RefreshTokenGrant", + "traits": { + "smithy.api#documentation": "

Configuration options for the refresh_token grant type.

" + } + }, + "TokenExchange": { + "target": "com.amazonaws.ssoadmin#TokenExchangeGrant", + "traits": { + "smithy.api#documentation": "

Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.

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

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

The Grant union represents the set of possible configuration options for the selected grant type. Exactly one member of the union must be specified, and must match the grant type selected.

" } }, "com.amazonaws.ssoadmin#GrantItem": { @@ -3648,20 +3660,20 @@ "GrantType": { "target": "com.amazonaws.ssoadmin#GrantType", "traits": { - "smithy.api#documentation": "

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

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

The type of the selected grant.

", "smithy.api#required": {} } }, "Grant": { "target": "com.amazonaws.ssoadmin#Grant", "traits": { - "smithy.api#documentation": "

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

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

The configuration structure for the selected grant.

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

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

A structure that defines a single grant and its configuration.

" } }, "com.amazonaws.ssoadmin#GrantType": { @@ -3907,12 +3919,12 @@ "AuthorizedTokenIssuers": { "target": "com.amazonaws.ssoadmin#AuthorizedTokenIssuers", "traits": { - "smithy.api#documentation": "

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

A list of allowed token issuers trusted by the Identity Center instances for this application.

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

~~~[ TODO: ADD DESCRIPTION HERE ]~~~

" + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant.

" } }, "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatus": { @@ -6582,6 +6594,13 @@ } } }, + "com.amazonaws.ssoadmin#RefreshTokenGrant": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the OAuth 2.0 Refresh Token Grant.

" + } + }, "com.amazonaws.ssoadmin#RelayState": { "type": "string", "traits": { @@ -8123,6 +8142,13 @@ "smithy.api#pattern": "^[-a-zA-Z0-9+=/_]*$" } }, + "com.amazonaws.ssoadmin#TokenExchangeGrant": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the OAuth 2.0 Token Exchange Grant.

" + } + }, "com.amazonaws.ssoadmin#TokenIssuerAudience": { "type": "string", "traits": { @@ -8365,7 +8391,7 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A structure that describes the options for the access portal associated with an application that can be updated.

" } }, "com.amazonaws.ssoadmin#UpdateApplicationRequest": { diff --git a/codegen/sdk-codegen/aws-models/sso-oidc.json b/codegen/sdk-codegen/aws-models/sso-oidc.json index ee4a8bbaad0..2974461fc06 100644 --- a/codegen/sdk-codegen/aws-models/sso-oidc.json +++ b/codegen/sdk-codegen/aws-models/sso-oidc.json @@ -36,6 +36,9 @@ { "target": "com.amazonaws.ssooidc#CreateToken" }, + { + "target": "com.amazonaws.ssooidc#CreateTokenWithIAM" + }, { "target": "com.amazonaws.ssooidc#RegisterClient" }, @@ -46,16 +49,16 @@ "traits": { "aws.api#service": { "sdkId": "SSO OIDC", - "arnNamespace": "awsssooidc", + "arnNamespace": "sso-oauth", "cloudFormationName": "SSOOIDC", "cloudTrailEventSource": "ssooidc.amazonaws.com", "endpointPrefix": "oidc" }, "aws.auth#sigv4": { - "name": "awsssooidc" + "name": "sso-oauth" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI\n or a native application) to register with IAM Identity Center. The service also enables the client to\n fetch the user’s access token upon successful authentication and authorization with\n IAM Identity Center.

\n \n

Although AWS Single Sign-On was renamed, the sso and\n identitystore API namespaces will continue to retain their original name for\n backward compatibility purposes. For more information, see IAM Identity Center rename.

\n \n

\n Considerations for Using This Guide\n

\n

Before you begin using this guide, we recommend that you first review the following\n important information about how the IAM Identity Center OIDC service works.

\n
    \n
  • \n

    The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0\n Device Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single\n sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed\n for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in\n future releases.

    \n
    • \n
  • \n

    The service emits only OIDC access tokens, such that obtaining a new token (For\n example, token refresh) requires explicit user re-authentication.

    \n
    • \n
  • \n

    The access tokens provided by this service grant access to all AWS account\n entitlements assigned to an IAM Identity Center user, not just a particular application.

    \n
    • \n
  • \n

    The documentation in this guide does not describe the mechanism to convert the access\n token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service\n endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference\n Guide.

    \n
    • \n
\n

For general information about IAM Identity Center, see What is\n IAM Identity Center? in the IAM Identity Center User Guide.

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

IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI\n or a native application) to register with IAM Identity Center. The service also enables the client to\n fetch the user’s access token upon successful authentication and authorization with\n IAM Identity Center.

\n \n

IAM Identity Center uses the sso and identitystore API namespaces.

\n \n

\n Considerations for Using This Guide\n

\n

Before you begin using this guide, we recommend that you first review the following\n important information about how the IAM Identity Center OIDC service works.

\n
    \n
  • \n

    The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device\n Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single\n sign-on authentication with the CLI.

    \n
    • \n
  • \n

    With older versions of the CLI, the service only emits OIDC access tokens, so to\n obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that\n supports token refresh and doesn’t require re-authentication, update to the latest CLI\n version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and\n configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .

    \n
    • \n
  • \n

    The access tokens provided by this service grant access to all Amazon Web Services account\n entitlements assigned to an IAM Identity Center user, not just a particular application.

    \n
    • \n
  • \n

    The documentation in this guide does not describe the mechanism to convert the access\n token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service\n endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference\n Guide.

    \n
    • \n
\n

For general information about IAM Identity Center, see What is\n IAM Identity Center? in the IAM Identity Center User Guide.

", "smithy.api#title": "AWS SSO OIDC", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -99,7 +102,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -142,7 +144,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -155,7 +158,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -169,7 +171,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -192,7 +193,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -227,7 +227,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -238,14 +237,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -259,14 +260,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -275,18 +274,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -295,7 +293,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -315,14 +314,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -336,7 +337,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -356,7 +356,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -367,14 +366,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -385,9 +386,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -963,10 +966,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be access_denied.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -976,7 +985,16 @@ } }, "com.amazonaws.ssooidc#AccessToken": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssooidc#Assertion": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.ssooidc#AuthCode": { "type": "string" @@ -985,10 +1003,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be authorization_pending.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1004,7 +1028,10 @@ "type": "string" }, "com.amazonaws.ssooidc#ClientSecret": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.ssooidc#ClientType": { "type": "string" @@ -1054,7 +1081,25 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Creates and returns an access token for the authorized client. The access token issued\n will be used to fetch short-term credentials for the assigned roles in the AWS\n account.

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

Creates and returns access and refresh tokens for clients that are authenticated using\n client secrets. The access token can be used to fetch short-term credentials for the assigned\n AWS accounts or to access application APIs using bearer authentication.

", + "smithy.api#examples": [ + { + "title": "Call OAuth/OIDC /token endpoint for Device Code grant with Secret authentication", + "documentation": "", + "input": { + "clientId": "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", + "clientSecret": "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", + "grantType": "urn:ietf:params:oauth:grant-type:device-code", + "deviceCode": "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE" + }, + "output": { + "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + "tokenType": "Bearer", + "expiresIn": 1579729529, + "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/token", @@ -1069,7 +1114,7 @@ "clientId": { "target": "com.amazonaws.ssooidc#ClientId", "traits": { - "smithy.api#documentation": "

The unique identifier string for each client. This value should come from the persisted\n result of the RegisterClient API.

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

The unique identifier string for the client or application. This value comes from the\n result of the RegisterClient API.

", "smithy.api#required": {} } }, @@ -1083,38 +1128,38 @@ "grantType": { "target": "com.amazonaws.ssooidc#GrantType", "traits": { - "smithy.api#documentation": "

Supports grant types for the authorization code, refresh token, and device code request.\n For device code requests, specify the following value:

\n

\n urn:ietf:params:oauth:grant-type:device_code\n \n

\n

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

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

Supports the following OAuth grant types: Device Code and Refresh Token.\n Specify either of the following values, depending on the grant type that you want:

\n

* Device Code - urn:ietf:params:oauth:grant-type:device_code\n

\n

* Refresh Token - refresh_token\n

\n

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

", "smithy.api#required": {} } }, "deviceCode": { "target": "com.amazonaws.ssooidc#DeviceCode", "traits": { - "smithy.api#documentation": "

Used only when calling this API for the device code grant type. This short-term code is\n used to identify this authentication attempt. This should come from an in-memory reference to\n the result of the StartDeviceAuthorization API.

" + "smithy.api#documentation": "

Used only when calling this API for the Device Code grant type. This short-term code is\n used to identify this authorization request. This comes from the result of the\n StartDeviceAuthorization API.

" } }, "code": { "target": "com.amazonaws.ssooidc#AuthCode", "traits": { - "smithy.api#documentation": "

The authorization code received from the authorization service. This parameter is required\n to perform an authorization grant request to get access to a token.

" + "smithy.api#documentation": "

Used only when calling this API for the Authorization Code grant type. The short-term code is\n used to identify this authorization request. This grant type is currently unsupported for the\n CreateToken API.

" } }, "refreshToken": { "target": "com.amazonaws.ssooidc#RefreshToken", "traits": { - "smithy.api#documentation": "

Currently, refreshToken is not yet implemented and is not supported. For more\n information about the features and limitations of the current IAM Identity Center OIDC implementation,\n see Considerations for Using this Guide in the IAM Identity Center\n OIDC API Reference.

\n

The token used to obtain an access token in the event that the access token is invalid or\n expired.

" + "smithy.api#documentation": "

Used only when calling this API for the Refresh Token grant type. This token is used to\n refresh short-term tokens, such as the access token, that might expire.

\n

For more information about the features and limitations of the current IAM Identity Center OIDC\n implementation, see Considerations for Using this Guide in the IAM Identity Center\n OIDC API Reference.

" } }, "scope": { "target": "com.amazonaws.ssooidc#Scopes", "traits": { - "smithy.api#documentation": "

The list of scopes that is defined by the client. Upon authorization, this list is used to\n restrict permissions when granting an access token.

" + "smithy.api#documentation": "

The list of scopes for which authorization is requested. The access token that is issued\n is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes\n all scopes that are configured for the client during the call to\n RegisterClient.

" } }, "redirectUri": { "target": "com.amazonaws.ssooidc#URI", "traits": { - "smithy.api#documentation": "

The location of the application that will receive the authorization code. Users authorize\n the service to send the request to this location.

" + "smithy.api#documentation": "

Used only when calling this API for the Authorization Code grant type. This value specifies\n the location of the client or application that has registered to receive the authorization\n code.

" } } }, @@ -1128,13 +1173,207 @@ "accessToken": { "target": "com.amazonaws.ssooidc#AccessToken", "traits": { - "smithy.api#documentation": "

An opaque token to access IAM Identity Center resources assigned to a user.

" + "smithy.api#documentation": "

A bearer token to access AWS accounts and applications assigned to a user.

" + } + }, + "tokenType": { + "target": "com.amazonaws.ssooidc#TokenType", + "traits": { + "smithy.api#documentation": "

Used to notify the client that the returned token is an access token. The supported token\n type is Bearer.

" + } + }, + "expiresIn": { + "target": "com.amazonaws.ssooidc#ExpirationInSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Indicates the time in seconds when an access token will expire.

" + } + }, + "refreshToken": { + "target": "com.amazonaws.ssooidc#RefreshToken", + "traits": { + "smithy.api#documentation": "

A token that, if present, can be used to refresh a previously issued access token that\n might have expired.

\n

For more\n information about the features and limitations of the current IAM Identity Center OIDC implementation,\n see Considerations for Using this Guide in the IAM Identity Center\n OIDC API Reference.

" + } + }, + "idToken": { + "target": "com.amazonaws.ssooidc#IdToken", + "traits": { + "smithy.api#documentation": "

The idToken is not implemented or supported. For more information about the\n features and limitations of the current IAM Identity Center OIDC implementation, see Considerations\n for Using this Guide in the IAM Identity Center\n OIDC API Reference.

\n

A JSON Web Token (JWT) that identifies who is associated with the issued access token.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssooidc#CreateTokenWithIAM": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssooidc#CreateTokenWithIAMRequest" + }, + "output": { + "target": "com.amazonaws.ssooidc#CreateTokenWithIAMResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssooidc#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssooidc#AuthorizationPendingException" + }, + { + "target": "com.amazonaws.ssooidc#ExpiredTokenException" + }, + { + "target": "com.amazonaws.ssooidc#InternalServerException" + }, + { + "target": "com.amazonaws.ssooidc#InvalidClientException" + }, + { + "target": "com.amazonaws.ssooidc#InvalidGrantException" + }, + { + "target": "com.amazonaws.ssooidc#InvalidRequestException" + }, + { + "target": "com.amazonaws.ssooidc#InvalidRequestRegionException" + }, + { + "target": "com.amazonaws.ssooidc#InvalidScopeException" + }, + { + "target": "com.amazonaws.ssooidc#SlowDownException" + }, + { + "target": "com.amazonaws.ssooidc#UnauthorizedClientException" + }, + { + "target": "com.amazonaws.ssooidc#UnsupportedGrantTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates and returns access and refresh tokens for clients and applications that are\n authenticated using IAM entities. The access token can be used to fetch short-term credentials\n for the assigned AWS accounts or to access application APIs using bearer\n authentication.

", + "smithy.api#examples": [ + { + "title": "Call OAuth/OIDC /token endpoint for Authorization Code grant with IAM authentication", + "documentation": "", + "input": { + "clientId": "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", + "grantType": "authorization_code", + "code": "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzg0In0EXAMPLEAUTHCODE", + "redirectUri": "https://mywebapp.example/redirect", + "scope": [ + "openid", + "aws", + "sts:identity_context" + ] + }, + "output": { + "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + "tokenType": "Bearer", + "expiresIn": 1579729529, + "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + "idToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsInN0czphdWRpdF9jb250ZXh0IjoiRVhBTVBMRUFVRElUQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.Xyah6qbk78qThzJ41iFU2yfGuRqqtKXHrJYwQ8L9Ip0", + "issuedTokenType": "urn:ietf:params:oauth:token-type:refresh_token", + "scope": [ + "openid", + "aws", + "sts:identity_context" + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/token?aws_iam=t", + "code": 200 + } + } + }, + "com.amazonaws.ssooidc#CreateTokenWithIAMRequest": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.ssooidc#ClientId", + "traits": { + "smithy.api#documentation": "

The unique identifier string for the client or application. This value is an application\n ARN that has OAuth grants configured.

", + "smithy.api#required": {} + } + }, + "grantType": { + "target": "com.amazonaws.ssooidc#GrantType", + "traits": { + "smithy.api#documentation": "

Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer,\n and Token Exchange. Specify one of the following values, depending on the grant type that you\n want:

\n

* Authorization Code - authorization_code\n

\n

* Refresh Token - refresh_token\n

\n

* JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer\n

\n

* Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange\n

", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.ssooidc#AuthCode", + "traits": { + "smithy.api#documentation": "

Used only when calling this API for the Authorization Code grant type. This short-term\n code is used to identify this authorization request. The code is obtained through a redirect\n from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the\n application.

" + } + }, + "refreshToken": { + "target": "com.amazonaws.ssooidc#RefreshToken", + "traits": { + "smithy.api#documentation": "

Used only when calling this API for the Refresh Token grant type. This token is used to\n refresh short-term tokens, such as the access token, that might expire.

\n

For more information about the features and limitations of the current IAM Identity Center OIDC\n implementation, see Considerations for Using this Guide in the IAM Identity Center\n OIDC API Reference.

" + } + }, + "assertion": { + "target": "com.amazonaws.ssooidc#Assertion", + "traits": { + "smithy.api#documentation": "

Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON\n Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer,\n configure the JWT Bearer GrantOptions for the application.

" + } + }, + "scope": { + "target": "com.amazonaws.ssooidc#Scopes", + "traits": { + "smithy.api#documentation": "

The list of scopes for which authorization is requested. The access token that is issued\n is limited to the scopes that are granted. If the value is not specified, IAM Identity Center authorizes all\n scopes configured for the application, including the following default scopes:\n openid, aws, sts:identity_context.

" + } + }, + "redirectUri": { + "target": "com.amazonaws.ssooidc#URI", + "traits": { + "smithy.api#documentation": "

Used only when calling this API for the Authorization Code grant type. This value specifies\n the location of the client or application that has registered to receive the authorization code.\n

" + } + }, + "subjectToken": { + "target": "com.amazonaws.ssooidc#SubjectToken", + "traits": { + "smithy.api#documentation": "

Used only when calling this API for the Token Exchange grant type. This value specifies\n the subject of the exchange. The value of the subject token must be an access token issued by\n IAM Identity Center to a different client or application. The access token must have authorized scopes\n that indicate the requested application as a target audience.

" + } + }, + "subjectTokenType": { + "target": "com.amazonaws.ssooidc#TokenTypeURI", + "traits": { + "smithy.api#documentation": "

Used only when calling this API for the Token Exchange grant type. This value specifies\n the type of token that is passed as the subject of the exchange. The following value is\n supported:

\n

* Access Token - urn:ietf:params:oauth:token-type:access_token\n

" + } + }, + "requestedTokenType": { + "target": "com.amazonaws.ssooidc#TokenTypeURI", + "traits": { + "smithy.api#documentation": "

Used only when calling this API for the Token Exchange grant type. This value specifies\n the type of token that the requester can receive. The following values are supported:

\n

* Access Token - urn:ietf:params:oauth:token-type:access_token\n

\n

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssooidc#CreateTokenWithIAMResponse": { + "type": "structure", + "members": { + "accessToken": { + "target": "com.amazonaws.ssooidc#AccessToken", + "traits": { + "smithy.api#documentation": "

A bearer token to access AWS accounts and applications assigned to a user.

" } }, "tokenType": { "target": "com.amazonaws.ssooidc#TokenType", "traits": { - "smithy.api#documentation": "

Used to notify the client that the returned token is an access token. The supported type\n is BearerToken.

" + "smithy.api#documentation": "

Used to notify the requester that the returned token is an access token. The supported\n token type is Bearer.

" } }, "expiresIn": { @@ -1147,13 +1386,25 @@ "refreshToken": { "target": "com.amazonaws.ssooidc#RefreshToken", "traits": { - "smithy.api#documentation": "

Currently, refreshToken is not yet implemented and is not supported. For more\n information about the features and limitations of the current IAM Identity Center OIDC implementation,\n see Considerations for Using this Guide in the IAM Identity Center\n OIDC API Reference.

\n

A token that, if present, can be used to refresh a previously issued access token that\n might have expired.

" + "smithy.api#documentation": "

A token that, if present, can be used to refresh a previously issued access token that\n might have expired.

\n

For more\n information about the features and limitations of the current IAM Identity Center OIDC implementation,\n see Considerations for Using this Guide in the IAM Identity Center\n OIDC API Reference.

" } }, "idToken": { "target": "com.amazonaws.ssooidc#IdToken", "traits": { - "smithy.api#documentation": "

Currently, idToken is not yet implemented and is not supported. For more\n information about the features and limitations of the current IAM Identity Center OIDC implementation,\n see Considerations for Using this Guide in the IAM Identity Center\n OIDC API Reference.

\n

The identifier of the user that associated with the access token, if present.

" + "smithy.api#documentation": "

A JSON Web Token (JWT) that identifies the user associated with the issued access token.\n

" + } + }, + "issuedTokenType": { + "target": "com.amazonaws.ssooidc#TokenTypeURI", + "traits": { + "smithy.api#documentation": "

Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:\n

\n

* Access Token - urn:ietf:params:oauth:token-type:access_token\n

\n

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token\n

" + } + }, + "scope": { + "target": "com.amazonaws.ssooidc#Scopes", + "traits": { + "smithy.api#documentation": "

The list of scopes for which authorization is granted. The access token that is issued\n is limited to the scopes that are granted.

" } } }, @@ -1180,10 +1431,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be expired_token.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1196,16 +1453,25 @@ "type": "string" }, "com.amazonaws.ssooidc#IdToken": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.ssooidc#InternalServerException": { "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be server_error.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1224,10 +1490,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be invalid_client.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1240,10 +1512,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be invalid_client_metadata.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1256,10 +1534,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be invalid_grant.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1272,10 +1556,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be invalid_request.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1284,14 +1574,54 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.ssooidc#InvalidRequestRegionException": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be invalid_request.

" + } + }, + "error_description": { + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } + }, + "endpoint": { + "target": "com.amazonaws.ssooidc#Location", + "traits": { + "smithy.api#documentation": "

Indicates the IAM Identity Center endpoint which the requester may call with this token.

" + } + }, + "region": { + "target": "com.amazonaws.ssooidc#Region", + "traits": { + "smithy.api#documentation": "

Indicates the region which the requester may call with this token.

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

Indicates that a token provided as input to the request was issued by and is only usable\n by calling IAM Identity Center endpoints in another region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.ssooidc#InvalidScopeException": { "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be invalid_scope.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1300,6 +1630,9 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.ssooidc#Location": { + "type": "string" + }, "com.amazonaws.ssooidc#LongTimeStampType": { "type": "long", "traits": { @@ -1307,6 +1640,12 @@ } }, "com.amazonaws.ssooidc#RefreshToken": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssooidc#Region": { "type": "string" }, "com.amazonaws.ssooidc#RegisterClient": { @@ -1334,6 +1673,26 @@ "traits": { "smithy.api#auth": [], "smithy.api#documentation": "

Registers a client with IAM Identity Center. This allows clients to initiate device authorization.\n The output should be persisted for reuse through many authentication requests.

", + "smithy.api#examples": [ + { + "title": "Call OAuth/OIDC /register-client endpoint", + "documentation": "", + "input": { + "clientName": "My IDE Plugin", + "clientType": "public", + "scopes": [ + "sso:account:access", + "codewhisperer:completions" + ] + }, + "output": { + "clientId": "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", + "clientSecret": "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", + "clientIdIssuedAt": 1579725929, + "clientSecretExpiresAt": 1587584729 + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/client/register", @@ -1402,13 +1761,13 @@ "authorizationEndpoint": { "target": "com.amazonaws.ssooidc#URI", "traits": { - "smithy.api#documentation": "

The endpoint where the client can request authorization.

" + "smithy.api#documentation": "

An endpoint that the client can use to request authorization.

" } }, "tokenEndpoint": { "target": "com.amazonaws.ssooidc#URI", "traits": { - "smithy.api#documentation": "

The endpoint where the client can get an access token.

" + "smithy.api#documentation": "

An endpoint that the client can use to create tokens.

" } } }, @@ -1429,10 +1788,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be slow_down.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1469,6 +1834,25 @@ "traits": { "smithy.api#auth": [], "smithy.api#documentation": "

Initiates device authorization by requesting a pair of verification codes from the\n authorization service.

", + "smithy.api#examples": [ + { + "title": "Call OAuth/OIDC /start-device-authorization endpoint", + "documentation": "", + "input": { + "clientId": "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", + "clientSecret": "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", + "startUrl": "https://identitycenter.amazonaws.com/ssoins-111111111111" + }, + "output": { + "deviceCode": "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE", + "userCode": "makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE", + "verificationUri": "https://device.sso.us-west-2.amazonaws.com", + "verificationUriComplete": "https://device.sso.us-west-2.amazonaws.com?user_code=makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE", + "expiresIn": 1579729529, + "interval": 1 + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/device_authorization", @@ -1497,7 +1881,7 @@ "startUrl": { "target": "com.amazonaws.ssooidc#URI", "traits": { - "smithy.api#documentation": "

The URL for the AWS access portal. For more information, see Using\n the AWS access portal in the IAM Identity Center User Guide.

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

The URL for the Amazon Web Services access portal. For more information, see Using\n the Amazon Web Services access portal in the IAM Identity Center User Guide.

", "smithy.api#required": {} } } @@ -1552,9 +1936,18 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssooidc#SubjectToken": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.ssooidc#TokenType": { "type": "string" }, + "com.amazonaws.ssooidc#TokenTypeURI": { + "type": "string" + }, "com.amazonaws.ssooidc#URI": { "type": "string" }, @@ -1562,10 +1955,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be unauthorized_client.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { @@ -1578,10 +1977,16 @@ "type": "structure", "members": { "error": { - "target": "com.amazonaws.ssooidc#Error" + "target": "com.amazonaws.ssooidc#Error", + "traits": { + "smithy.api#documentation": "

Single error code.\n For this exception the value will be unsupported_grant_type.

" + } }, "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" + "target": "com.amazonaws.ssooidc#ErrorDescription", + "traits": { + "smithy.api#documentation": "

Human-readable text providing additional information, used to assist the\n client developer in understanding the error that occurred.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/sts.json b/codegen/sdk-codegen/aws-models/sts.json index ad261493c74..e8ccef1b150 100644 --- a/codegen/sdk-codegen/aws-models/sts.json +++ b/codegen/sdk-codegen/aws-models/sts.json @@ -173,7 +173,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -624,7 +623,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -637,7 +637,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -680,7 +679,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -693,7 +693,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -707,7 +706,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -730,7 +728,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -765,7 +762,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -776,14 +772,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -797,14 +795,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -813,18 +809,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -833,7 +828,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -853,14 +849,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -874,7 +872,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -894,7 +891,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -905,14 +901,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -950,9 +948,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1665,9 +1665,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1684,10 +1684,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false, - "Region": "ap-northeast-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1697,9 +1697,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1716,10 +1716,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1729,9 +1729,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1748,10 +1748,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "ap-southeast-1", "UseFIPS": false, - "Region": "ap-southeast-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1761,9 +1761,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1780,10 +1780,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "ap-southeast-2" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1793,9 +1793,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1812,10 +1812,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "aws-global", "UseFIPS": false, - "Region": "aws-global" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1825,9 +1825,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1844,10 +1844,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "ca-central-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1857,9 +1857,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1876,10 +1876,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1889,9 +1889,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1908,10 +1908,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "eu-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1921,9 +1921,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1940,10 +1940,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "eu-west-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1953,9 +1953,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -1972,10 +1972,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -1985,9 +1985,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -2004,10 +2004,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "eu-west-3", "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -2017,9 +2017,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -2036,10 +2036,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -2049,9 +2049,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -2068,10 +2068,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -2081,9 +2081,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -2100,10 +2100,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -2113,9 +2113,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -2132,10 +2132,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -2145,9 +2145,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -2164,10 +2164,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -2177,9 +2177,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-3", + "name": "sigv4", "signingName": "sts", - "name": "sigv4" + "signingRegion": "us-east-3" } ] }, @@ -2196,10 +2196,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, + "Region": "us-east-3", "UseFIPS": false, - "Region": "us-east-3" + "UseDualStack": false, + "UseGlobalEndpoint": true } }, { @@ -2220,10 +2220,10 @@ } ], "params": { - "UseGlobalEndpoint": true, - "UseDualStack": false, - "UseFIPS": false, "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true, "Endpoint": "https://example.com" } }, @@ -2235,9 +2235,9 @@ } }, "params": { - "UseGlobalEndpoint": false, - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": false, "Endpoint": "https://example.com" } } @@ -2389,7 +2389,7 @@ "ProvidedContexts": { "target": "com.amazonaws.sts#ProvidedContextsListType", "traits": { - "smithy.api#documentation": "

Reserved for future use.

" + "smithy.api#documentation": "

A list of previously acquired trusted context assertions in the format of a JSON array.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.

\n

The following is an example of a ProvidedContext value that includes a\n single trusted context assertion and the ARN of the context provider from which the trusted\n context assertion was generated.

\n

\n [{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/identitycenter\",\"ContextAssertion\":\"trusted-context-assertion\"}]\n

" } } }, @@ -3356,18 +3356,18 @@ "ProviderArn": { "target": "com.amazonaws.sts#arnType", "traits": { - "smithy.api#documentation": "

Reserved for future use.

" + "smithy.api#documentation": "

The context provider ARN from which the trusted context assertion was generated.

" } }, "ContextAssertion": { "target": "com.amazonaws.sts#contextAssertionType", "traits": { - "smithy.api#documentation": "

Reserved for future use.

" + "smithy.api#documentation": "

The signed and encrypted trusted context assertion generated by the context provider.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.

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

Reserved for future use.

" + "smithy.api#documentation": "

Contains information about the provided context. This includes the signed and encrypted\n trusted context assertion and the context provider ARN from which the trusted context\n assertion was generated.

" } }, "com.amazonaws.sts#ProvidedContextsListType": { diff --git a/codegen/sdk-codegen/aws-models/trustedadvisor.json b/codegen/sdk-codegen/aws-models/trustedadvisor.json new file mode 100644 index 00000000000..0c2e7dcc5b8 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/trustedadvisor.json @@ -0,0 +1,3863 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.trustedadvisor#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Exception that access has been denied due to insufficient access

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.trustedadvisor#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummary": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID

" + } + }, + "accountRecommendationArn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "

The Recommendation ARN

" + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "

The lifecycle stage from AWS Trusted Advisor Priority

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

The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information\n is only available when a Technical Account Manager takes an action on a recommendation managed by AWS\n Trusted Advisor Priority\n

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

The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation.\n This information is only available when a Technical Account Manager takes an action on a recommendation\n managed by AWS Trusted Advisor Priority\n

" + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "

Reason for the lifecycle stage change

" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "

Reason code for the lifecycle state change

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

When the Recommendation was last updated

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

Summary of an AccountRecommendationLifecycle for an Organization Recommendation

" + } + }, + "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummary" + } + }, + "com.amazonaws.trustedadvisor#CheckArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::check\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#CheckIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 64 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::check\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#CheckSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the AWS Trusted Advisor Check

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#CheckArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS Trusted Advisor Check

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

The name of the AWS Trusted Advisor Check

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

A description of what the AWS Trusted Advisor Check is monitoring

", + "smithy.api#required": {} + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "

The Recommendation pillars that the AWS Trusted Advisor Check falls under

", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "

The AWS Services that the Check applies to

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

The source of the Recommendation

", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.trustedadvisor#StringMap", + "traits": { + "smithy.api#documentation": "

The column headings for the metadata returned in the resource

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

A summary of an AWS Trusted Advisor Check

" + } + }, + "com.amazonaws.trustedadvisor#CheckSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#CheckSummary" + } + }, + "com.amazonaws.trustedadvisor#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Exception that the request was denied due to conflictions in state

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.trustedadvisor#GetOrganizationRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#GetOrganizationRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#GetOrganizationRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized\n recommendations.\n

", + "smithy.api#examples": [ + { + "title": "Get an AWS Organization's Recommendation by ARN", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5" + }, + "output": { + "organizationRecommendation": { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "name": "Lambda Runtime Deprecation Warning", + "description": "One or more lambdas are using a deprecated runtime", + "awsServices": [ + "lambda" + ], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved", + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#GetOrganizationRecommendationRequest": { + "type": "structure", + "members": { + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "

The Recommendation identifier

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#GetOrganizationRecommendationResponse": { + "type": "structure", + "members": { + "organizationRecommendation": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendation", + "traits": { + "smithy.api#documentation": "

The Recommendation

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#GetRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#GetRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#GetRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a specific Recommendation

", + "smithy.api#examples": [ + { + "title": "Get a Recommendation by ARN", + "input": { + "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578" + }, + "output": { + "recommendation": { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "name": "MFA Recommendation", + "description": "Enable multi-factor authentication", + "awsServices": [ + "iam" + ], + "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", + "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", + "lastUpdatedAt": "2023-11-01T15:57:58.673Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "error", + "type": "standard" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/recommendations/{recommendationIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#GetRecommendationRequest": { + "type": "structure", + "members": { + "recommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "

The Recommendation identifier

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#GetRecommendationResponse": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.trustedadvisor#Recommendation", + "traits": { + "smithy.api#documentation": "

The Recommendation

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Exception to notify that an unexpected internal error occurred during processing of the request

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.trustedadvisor#ListChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListChecksRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListChecksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List a filterable set of Checks

", + "smithy.api#examples": [ + { + "title": "List all AWS Trusted Advisor Checks", + "input": {}, + "output": { + "checkSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::check/1iG5NDGVre", + "awsServices": [ + "EC2" + ], + "description": "Checks security groups for rules that allow unrestricted access to a resource. Unrestricted access increases opportunities for malicious activity (hacking, denial-of-service attacks, loss of data).\n
\n
Note: This check only evaluates security groups that you create and their inbound rules for IPv4 addresses. Security groups created by AWS Directory Services are flagged as red or yellow, but they don’t pose a security risk and can be safely ignored or excluded. For more information, see the Trusted Advisor FAQ.\n
\n
\n

Alert Criteria

\n
\nRed: A security group rule has a source IP address with a /0 suffix for ports other than 25, 80, or 443.\n
\n
\n

Recommended Action

\n
\nRestrict access to only those IP addresses that require it. To restrict access to a specific IP address, set the suffix to /32 (for example, 192.0.2.10/32). Be sure to delete overly permissive rules after creating rules that are more restrictive.\n
\n
\n

Additional Resources

\n
Amazon EC2 Security Groups
\nClassless Inter-Domain Routing (Wikipedia)", + "id": "1iG5NDGVre", + "metadata": {}, + "name": "Security Groups - Unrestricted Access", + "pillars": [ + "security" + ], + "source": "ta_check" + }, + { + "arn": "arn:aws:trustedadvisor:::check/1qazXsw23e", + "awsServices": [ + "RDS" + ], + "description": "Checks your usage of RDS and provides recommendations on purchase of Reserved Instances to help reduce costs incurred from using RDS On-Demand. AWS generates these recommendations by analyzing your On-Demand usage for the past 30 days. We then simulate every combination of reservations in the generated category of usage in order to identify the best number of each type of Reserved Instance to purchase to maximize your savings. This check covers recommendations based on partial upfront payment option with 1-year or 3-year commitment. This check is not available to accounts linked in Consolidated Billing. Recommendations are only available for the Paying Account.

\r\n

Alert Criteria


\nYellow: Optimizing the purchase of RDS Reserved Instances can help reduce costs.

\r\n

Recommended Action


\r\nSee the Cost Explorer page for more detailed recommendations, customization options (e.g. look-back period, payment option, etc.) and to purchase RDS Reserved Instances.\n
\n
\n

Additional Resources


\nInformation on RDS Reserved Instances and how they can save you money can be found here.
\nFor more information on this recommendation, see Reserved Instance Optimization Check Questions in the Trusted Advisor FAQs.
\nFor more detailed description of fields, see Cost Explorer documentation", + "id": "1qazXsw23e", + "metadata": { + "properties.averageUtilization": "Expected Average Reserved Instance Utilization", + "properties.databaseEdition": "Database Edition", + "properties.databaseEngine": "Database Engine", + "properties.deploymentOption": "Deployment Option", + "properties.estimatedBreakEvenInMonths": "Estimated Break Even (months)", + "properties.estimatedMonthlyOnDemandCost": "Estimated On-Demand Cost Post Recommended Reserved Instance Purchase (monthly)", + "properties.estimatedMonthlySavingsAmount": "Estimated Savings with Recommendation (monthly)", + "properties.family": "Family", + "properties.instanceType": "Instance Type", + "properties.licenseModel": "License Model", + "properties.lookbackPeriodInDays": "Lookback Period (days)", + "properties.recommendedNumberOfInstancesToPurchase": "Recommended number of Reserved Instances to purchase", + "properties.recurringStandardMonthlyCost": "Estimated cost of Reserved Instances (monthly)", + "properties.region": "Region", + "properties.termInYears": "Term (years)", + "properties.upfrontCost": "Upfront Cost of Reserved Instances" + }, + "name": "Amazon Relational Database Service (RDS) Reserved Instance Optimization", + "pillars": [ + "cost_optimizing" + ], + "source": "ta_check" + }, + { + "arn": "arn:aws:trustedadvisor:::check/1qw23er45t", + "awsServices": [ + "Redshift" + ], + "description": "Checks your usage of Redshift and provides recommendations on purchase of Reserved Nodes to help reduce costs incurred from using Redshift On-Demand. AWS generates these recommendations by analyzing your On-Demand usage for the past 30 days. We then simulate every combination of reservations in the generated category of usage in order to identify the best number of each type of Reserved Nodes to purchase to maximize your savings. This check covers recommendations based on partial upfront payment option with 1-year or 3-year commitment. This check is not available to accounts linked in Consolidated Billing. Recommendations are only available for the Paying Account.

\n

Alert Criteria


Yellow: Optimizing the purchase of Redshift Reserved Nodes can help reduce costs.

\n

Recommended Action


See the Cost Explorer page for more detailed recommendations, customization options (e.g. look-back period, payment option, etc.) and to purchase Redshift Reserved Nodes.

\n

Additional Resources


Information on Redshift Reserved Nodes and how they can save you money can be found here.
\nFor more information on this recommendation, see Reserved Instance Optimization Check Questions in the Trusted Advisor FAQs.
\nFor more detailed description of fields, see Cost Explorer documentation", + "id": "1qw23er45t", + "metadata": { + "properties.averageUtilization": "Expected Average Reserved Node Utilization", + "properties.estimatedBreakEvenInMonths": "Estimated Break Even (months)", + "properties.estimatedMonthlyOnDemandCost": "Estimated On-Demand Cost Post Recommended Reserved Nodes Purchase (monthly)", + "properties.estimatedMonthlySavingsAmount": "Estimated Savings with Recommendation (monthly)", + "properties.family": "Family", + "properties.lookbackPeriodInDays": "Lookback Period (days)", + "properties.nodeType": "Node Type", + "properties.recommendedNumberOfInstancesToPurchase": "Recommended number of Reserved Nodes to purchase", + "properties.recurringStandardMonthlyCost": "Estimated cost of Reserved Nodes (monthly)", + "properties.region": "Region", + "properties.termInYears": "Term (years)", + "properties.upfrontCost": "Upfront Cost of Reserved Nodes" + }, + "name": "Amazon Redshift Reserved Node Optimization", + "pillars": [ + "cost_optimizing" + ], + "source": "ta_check" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBRVVwQzBxdDBCOFAzZDRJczV2aGN0cUFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTWxoM2N4K1JBTm9TM2tqVHNBZ0VRZ0R0U1hlNzVJNG4vZHljU0plUWN6NHJONVVHZmVEQ1FsT3pQdmx3V29lUndJMWs4QldJZ3FIRnNJMDUzSTRNSnlWQUsxeCtJN1ROM2hrcmZPUT09sJdl-7H5vLEjKO0UvvSHSUgK48BRPR5gU8d9MbO68zE_aQsbJcIiW0AAVnc6YGhUFEcdpnIszLoB6QHKZwTnEIXv5jkt7nFhorlfeT_YqCAPMrQsbJKGwCRAyTkHYPbQCHZtlE-hb9TnGmBO1I44yB9yoqE2iy9BwsdGm_GDAtBkDWng_WJP0_qWBnZlbtGnJrseVbV5UN1vNfTvxFJ1TQ8JSQpiFwgQ_JIMcj3fVyhON1K1QoWGn6fPpYyN5ZwNh4imjrIBl3O3RoKz5EXpJG3yFqA_UhXIfQa0eaNcRqNadbYkLok=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/checks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "checkSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListChecksRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "pillar": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar", + "traits": { + "smithy.api#documentation": "

The pillar of the check

", + "smithy.api#httpQuery": "pillar" + } + }, + "awsService": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService", + "traits": { + "smithy.api#documentation": "

The aws service associated with the check

", + "smithy.api#httpQuery": "awsService" + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "

The source of the check

", + "smithy.api#httpQuery": "source" + } + }, + "language": { + "target": "com.amazonaws.trustedadvisor#RecommendationLanguage", + "traits": { + "smithy.api#documentation": "

The ISO 639-1 code for the language that you want your checks to appear in.

", + "smithy.api#httpQuery": "language" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListChecksResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "checkSummaries": { + "target": "com.amazonaws.trustedadvisor#CheckSummaryList", + "traits": { + "smithy.api#documentation": "

The list of Checks

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the accounts that own the resources for an organization aggregate recommendation. This API only\n supports prioritized recommendations.\n

", + "smithy.api#examples": [ + { + "title": "List all Accounts for an AWS Organization's Recommendation", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5" + }, + "output": { + "accountRecommendationLifecycleSummaries": [ + { + "accountId": "000000000000", + "accountRecommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBRXh1QXZLTHlrTTFGcExuNmxVbWcxdEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUY2WWU5NVVZZXVBY0ZyOS9BZ0VRZ0RzZmZWdkFNYWU3akxUS0Fmc1dBUmdsTlJadWI3ZDhGWHF5eTNBOTloenpzNUJ3WUZnWjY3MzM1N3B2eGVQcDhQMHl3NGJrSFlHMTNEN0NaQT09KF3n6Ghj-Z9I8pjzwpxNB8fZMSZCS2Eh5pZdfoz5BP87e0KUXIzWLwupY-OGmK_klEh_J6lQMjVZmvR_C1BqTqZs0t3O0UNh29UPNdvfxIC2y2Wkrl4vKf8Zjs60ysx_eP9vVX01kpv1mxacIji9gp6lCRkMEAMmCfqW8a4bUKLZ93umoGVdYCPn_nKZHMHvqDtpHO-zHMeW2hXf8RQNQKR9pfWDsp_NBjWBqkaTuNyjOE3ardMrFnyK7CMvIHjBwn8_8guzGpY0UKVNldWzyUQRbgVXTxF-xkSMzxrOm6rxMXFbrAE=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}/accounts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "accountRecommendationLifecycleSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "

The Recommendation identifier

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "affectedAccountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "

An account affected by this organization recommendation

", + "smithy.api#httpQuery": "affectedAccountId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccountsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "accountRecommendationLifecycleSummaries": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationLifecycleSummaryList", + "traits": { + "smithy.api#documentation": "

The account recommendations lifecycles that are applicable to the Recommendation

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List Resources of a Recommendation within an Organization. This API only supports prioritized\n recommendations.\n

", + "smithy.api#examples": [ + { + "title": "List all Resources for an AWS Organization's Recommendation", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0" + }, + "output": { + "organizationRecommendationResourceSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/5a694939-2e54-45a2-ae72-730598fa89d0/bb38affc0ce0681d9a6cd13f30238ba03a8f63dfe7a379dc403c619119d86af", + "awsResourceId": "database-1-instance-1", + "id": "bb38affc0ce0681d9a6cd13f302383ba03a8f63dfe7a379dc403c619119d86af", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "208.79999999999998", + "instanceName": "database-1-instance-1", + "instanceType": "db.r5.large", + "multiAZ": "false", + "region": "us-west-2", + "resourceARN": "arn:aws:rds:us-west-2:000000000000:db:database-1-instance-1", + "storageSizeGB": "1" + }, + "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", + "regionCode": "us-west-2", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/5a694939-2e54-45a2-ae72-730598fa89d0/51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", + "awsResourceId": "database-1", + "id": "51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "31.679999999999996", + "instanceName": "database-1", + "instanceType": "db.t3.small", + "multiAZ": "false", + "region": "us-west-2", + "resourceARN": "arn:aws:rds:us-west-2:000000000000:db:database-1", + "storageSizeGB": "20" + }, + "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", + "regionCode": "us-west-2", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/5a694939-2e54-45a2-ae72-730598fa89d0/f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", + "awsResourceId": "database-2-instance-1-us-west-2a", + "id": "f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "187.20000000000002", + "instanceName": "database-2-instance-1-us-west-2a", + "instanceType": "db.r6g.large", + "multiAZ": "true", + "region": "us-west-2", + "resourceARN": "arn:aws:rds:us-west-2:000000000000:db:database-2-instance-1-us-west-2a", + "storageSizeGB": "1" + }, + "recommendationArn": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", + "regionCode": "us-west-2", + "status": "warning" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBRkh6azN0L1pnN1RldmE4L0N2TjRBOUFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTF2dEdvL0hyYjgrekZxL3FBZ0VRZ0Rzem5HWHZiV2NhOG5TdEE5ZmFoWHpSRm1xU0dUcVAvOFBteW5OWFFkZjNKT3NMUXNDblVsMTlCUnZHS3BKQnFZTlNwbXl2VEllaGFEU1gvUT09W0JMIfQ6puz70ZdK2v6sV1XDCgBIh_e6D-jVUuQQjUaIoy0uLO9QfGrlcSiJ-WvNfhbg8zO0JLcNl6s6bXqZZPZYtnMXiZ_-ygAQhajX_ObCAOedCjpcfikGf6d6KwrjVUplGOaO_NA0Xp6LJExCnViusJCzmKbLOHoBSsdEknb4kY88-iZ1lebblumsWBxsZ8ADcguSLon5IXlejoDf6UukwoM3Z7EjIue3O_OR0gT9DST52shjyNObOzPizO-auI2ZoNKE1y4bzIKtWHzqRfAHHMT4VspFBm58564FqedKqF-D71k=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}/resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "organizationRecommendationResourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the resource

", + "smithy.api#httpQuery": "status" + } + }, + "regionCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The AWS Region code of the resource

", + "smithy.api#httpQuery": "regionCode" + } + }, + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "

The AWS Organization organization's Recommendation identifier

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "affectedAccountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "

An account affected by this organization recommendation

", + "smithy.api#httpQuery": "affectedAccountId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResourcesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "organizationRecommendationResourceSummaries": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummaryList", + "traits": { + "smithy.api#documentation": "

A list of Recommendation Resources

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List a filterable set of Recommendations within an Organization. This API only supports prioritized\n recommendations.\n

", + "smithy.api#examples": [ + { + "title": "List all of an AWS Organization's Recommendations", + "input": {}, + "output": { + "organizationRecommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": [ + "lambda" + ], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved", + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + }, + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": [ + "lambda" + ], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "lifecycleStage": "resolved", + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBCmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBSEwveUo0WGtzUERDZUEweDdjVXNJUkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVA1Q0tvVHlvaVBMMXBheFJBZ0VRZ0R0M3NSQXhJNVNoNVJGdFpXN2tjc3JRenlDSDFqaHRkbXp6VTYxZkw0V2lKbkhWeTFqZllaY2prNERPd1hUM2lZVjdZdnJpblRjRFNIVHExZz09wONgOWmSmHcQa82lL7tfrIIiz5kwiP348ZRHDFnNtRRBmuyjwEy8nWAjw_ldisYaifLWtlT31JCln5EAe7tt9c5D_pn2gh-m6EIakcQKX61DY-wuxYIKfeu1ibferY2wq_dTEbqXY6OVN-0N84GKe2azBRV9N80PLouIpG-bt9VjsqdTviEFs3eQnEDJnxRGQmgXrJQFTZIqSLDSsC2-niOVkY7HNvWtLT3fHvXUfFDfD5XlMeWL3DBbnD9beij553VbvnbuKj50BcoV2zWqgc8_eFM4xM0Gsc16OajX0Xio6ZdmwOM=" + } + }, + { + "title": "Filter and return a max of one AWS Organization Recommendation that is a part of the \"security\" pillar", + "input": { + "pillar": "security", + "maxResults": 1 + }, + "output": { + "organizationRecommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": [ + "lambda" + ], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", + "lifecycleStage": "resolved", + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBSG15cmpVYXd3bUtUM0J2dzhleUsyakFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUFadFFiRTl2VmlCZWN4WHNBZ0VRZ0RzdWRPMTFVWDNjUW9MNStEeTU0QktWQlNMeDBSa3RoeG9UZVJONjRFQzJBUDdvMTdvRTMxTWlJL1FvdE9neGtYWk1aZmx1dFpybHBwRjRTUT093orMKsmELla57p7di2_DnzTGQJxzgjD9HBZApR3831zITqaZo5aTHJ8q59gon_DhD0s2sm3dY8f3SmZxI7IevqI6Vz1UTY0C3IIsyA6XrQiXwfNo36mumo_W7eSf9xNk1CD_to2qwxq-b6m1-88SfNzfvzoA4x52DBczJZNYERmdQRkh-CRs3CSnTdFdXvb8fuyONmJnJuSB5x06IIBpMhLIQqNYLkofnsWRxDUAppOE0aRNfzC4iajmWq9JiYytfc9yGsbU4bqplPYerEtSIRau0QfBrnfifJL7VilfaIwrEs_j_ekqLQ==" + } + }, + { + "title": "Use the \"nextToken\" returned from a previous request to fetch the next page of filtered AWS Organization Recommendations that are a part of the \"security\" pillar", + "input": { + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBSG15cmpVYXd3bUtUM0J2dzhleUsyakFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUFadFFiRTl2VmlCZWN4WHNBZ0VRZ0RzdWRPMTFVWDNjUW9MNStEeTU0QktWQlNMeDBSa3RoeG9UZVJONjRFQzJBUDdvMTdvRTMxTWlJL1FvdE9neGtYWk1aZmx1dFpybHBwRjRTUT093orMKsmELla57p7di2_DnzTGQJxzgjD9HBZApR3831zITqaZo5aTHJ8q59gon_DhD0s2sm3dY8f3SmZxI7IevqI6Vz1UTY0C3IIsyA6XrQiXwfNo36mumo_W7eSf9xNk1CD_to2qwxq-b6m1-88SfNzfvzoA4x52DBczJZNYERmdQRkh-CRs3CSnTdFdXvb8fuyONmJnJuSB5x06IIBpMhLIQqNYLkofnsWRxDUAppOE0aRNfzC4iajmWq9JiYytfc9yGsbU4bqplPYerEtSIRau0QfBrnfifJL7VilfaIwrEs_j_ekqLQ==", + "pillar": "security", + "maxResults": 1 + }, + "output": { + "organizationRecommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor:::organization-recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "name": "Lambda Runtime Deprecation Warning", + "awsServices": [ + "lambda" + ], + "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", + "id": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", + "lifecycleStage": "resolved", + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 150, + "okCount": 500, + "warningCount": 100 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/organization-recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "organizationRecommendationSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "

The type of the Recommendation

", + "smithy.api#httpQuery": "type" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "

The status of the Recommendation

", + "smithy.api#httpQuery": "status" + } + }, + "pillar": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar", + "traits": { + "smithy.api#documentation": "

The pillar of the Recommendation

", + "smithy.api#httpQuery": "pillar" + } + }, + "awsService": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService", + "traits": { + "smithy.api#documentation": "

The aws service associated with the Recommendation

", + "smithy.api#httpQuery": "awsService" + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "

The source of the Recommendation

", + "smithy.api#httpQuery": "source" + } + }, + "checkIdentifier": { + "target": "com.amazonaws.trustedadvisor#CheckIdentifier", + "traits": { + "smithy.api#documentation": "

The check identifier of the Recommendation

", + "smithy.api#httpQuery": "checkIdentifier" + } + }, + "afterLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

After the last update of the Recommendation

", + "smithy.api#httpQuery": "afterLastUpdatedAt" + } + }, + "beforeLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Before the last update of the Recommendation

", + "smithy.api#httpQuery": "beforeLastUpdatedAt" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListOrganizationRecommendationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "organizationRecommendationSummaries": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationSummaryList", + "traits": { + "smithy.api#documentation": "

The list of Recommendations

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationResourcesRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List Resources of a Recommendation

", + "smithy.api#examples": [ + { + "title": "List all Resources for a Recommendation", + "input": { + "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578" + }, + "output": { + "recommendationResourceSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", + "id": "18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", + "awsResourceId": "webcms-dev-01", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "123.12000000000002", + "instanceName": "webcms-dev-01", + "instanceType": "db.m6i.large", + "multiAZ": "false", + "region": "us-east-1", + "resourceARN": "arn:aws:rds:us-east-1:000000000000:db:webcms-dev-01", + "storageSizeGB": "20" + }, + "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "regionCode": "us-east-1", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/e6367ff500ac90db8e4adeb4892e39ee9c36bbf812dcbce4b9e4fefcec9eb63e", + "id": "e6367ff500ac90db8e4adeb4892e39ee9c36bbf812dcbce4b9e4fefcec9eb63e", + "awsResourceId": "aws-dev-db-stack-instance-1", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "29.52", + "instanceName": "aws-dev-db-stack-instance-1", + "instanceType": "db.t2.small", + "multiAZ": "false", + "region": "us-east-1", + "resourceARN": "arn:aws:rds:us-east-1:000000000000:db:aws-dev-db-stack-instance-1", + "storageSizeGB": "1" + }, + "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "regionCode": "us-east-1", + "status": "warning" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/31aa78ba050a5015d2d38cca7f5f1ce88f70857c4e1c3ad03f8f9fd95dad7459", + "id": "31aa78ba050a5015d2d38cca7f5f1ce88f70857c4e1c3ad03f8f9fd95dad7459", + "awsResourceId": "aws-awesome-apps-stack-db", + "lastUpdatedAt": "2023-11-01T15:09:51.891Z", + "metadata": { + "daysSinceLastConnection": "14", + "estimatedMonthlySavings": "114.48000000000002", + "instanceName": "aws-awesome-apps-stack-db", + "instanceType": "db.m6g.large", + "multiAZ": "false", + "region": "us-east-1", + "resourceARN": "arn:aws:rds:us-east-1:000000000000:db:aws-awesome-apps-stack-db", + "storageSizeGB": "100" + }, + "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "regionCode": "us-east-1", + "status": "warning" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmJTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBRmZpZ2taY09rdSt5VXhocEdLR0k3TUFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTWZoU3BQNUxtMkt3THpCTG5BZ0VRZ0R2WjBHdzljc3RsV2ZiSkg0QkcvUkJQZDhIc0dGTHNLOXhLc1p5bU8vVlBtYy90dThSYmVKVUhxM3RTS1JwUDB4bWp2dU1jSGQxV3BOTU40UT09pyOzpADaUjX5i75XDGEpw6TEkHoxZsepcoWjQtXjvAYrKILVkdI0lpSZqghK4mPnFGgecInr0_-BJ4ud9TPCZmnNxr7MuYTYJVFWArAaddEw3oJFOY8YLQHjJ37LsY_dEpMN6oDwdAdcdyEZBUBeK71f6XPQa0S1sw5Si_NYuJEvQ3bPZiS8V07IUkUUhe_gE1_xjGK2mA3eTW0wiylW0l8jfz3u8lC6md_5GmvVrtphEkWoc4A9DIfR9CsX_bmvOa4P3NI9rZ9-gezuhkd3k3nXqH52hZPI1fl5iyd4vSFXlvaeawI=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/recommendations/{recommendationIdentifier}/resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "recommendationResourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationResourcesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the resource

", + "smithy.api#httpQuery": "status" + } + }, + "regionCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The AWS Region code of the resource

", + "smithy.api#httpQuery": "regionCode" + } + }, + "recommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "

The Recommendation identifier

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationResourcesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "recommendationResourceSummaries": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceSummaryList", + "traits": { + "smithy.api#documentation": "

A list of Recommendation Resources

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.trustedadvisor#ListRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List a filterable set of Recommendations

", + "smithy.api#examples": [ + { + "title": "List all Recommendations", + "input": {}, + "output": { + "recommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "name": "MFA Recommendation", + "awsServices": [ + "iam" + ], + "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", + "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", + "lastUpdatedAt": "2023-11-01T15:57:58.673Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "error", + "type": "standard" + }, + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "name": "RDS clusters quota warning", + "awsServices": [ + "rds" + ], + "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz", + "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "lastUpdatedAt": "2023-11-01T15:58:17.397Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": [ + "service_limits" + ], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBR3RUWW1ma3MwY0plS0llWENTZHV0SkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUVSUDNkclhLblpkd3h4MW5BZ0VRZ0RzTFBpOTlzZmppYXJxMjJoMHlRWDV6bkFuRGZna3FOZEpKaWtuUGloUWpFRzFrSnR6eWV2UGVjWFZudEw1RHQ0dkdvQ1RXL2hGeERFNG44QT09NZONpU850LXJxneOHiAMVmAkpDmCUH5-ob34VBXNqkq9y3s54mW4se3VGv6Ds85WwEaW9uEAM3HpLWMLJjw6u3rLFdwzvNsmicgmGvBd_kZVXJ_bo3Oqgo9koXDg5ltCZt8nxhp-6FnU8dyBDdSENAlQ3ldIb6QIyyRCH5185coh7UYIjbtd7Ne-TMgHk2HsLongKnbz1Lq6dfOm3mqHyJHAmrU8Qnbm10X2Ph9ZsolloEw4HiGMdEKL5-DnGRgXp3gZLuOTrAuukHwqpd1-cRZYHxmjaIUFiSuVuSC4QlWDeeiqlPo=" + } + }, + { + "title": "Filter and return a max of one Recommendation that is a part of AWS IAM", + "input": { + "awsService": "iam", + "maxResults": 1 + }, + "output": { + "recommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578", + "name": "MFA Recommendation", + "awsServices": [ + "iam" + ], + "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", + "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", + "lastUpdatedAt": "2023-11-01T15:57:58.673Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": [ + "security" + ], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "error", + "type": "standard" + } + ], + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBR01zYktEMDlmSm5nSkM1TGYzaWtTNkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVlwVDdDRk01cTdzV0JnRmhBZ0VRZ0R1dVg4dkVOYjZYTHJ6WVhvUlBWQVg1YU5KZkkraElsNk5lTjh3TXpzWkhHUEVzWXNkbXI2bTZzNTl1TEhKWUN2dGpqOENpTzVzM0FDT3BqZz09S35zPCUsSxxYFtdXw7z8BaSuDmz9P1Toit_MFrXsfpnPmDd6Q1f1NaJhi3O8NoZvzinXknKoKxTeqSumUaHe7W3n6Xa3661LF979aPdhifpKw3-MQpb5oGdXGgU7UMlXHzwISkND7sLlh_s0V-jkRvWPZjLHwLg4dUCQnIqMEwo5G3IG6Ffn-SKHhqPimTnzgOrxK2i9LA0EEj6msvH00h4YXuG9M3hFP9X52T19ZGZfdDPhVKCtSshXtQ8zcCUB8ykgw8ROJvAwzQk8I1PMIS4dirHySKOgoowu4Um3bZE6hHex-zXsjA==" + } + }, + { + "title": "Use the \"nextToken\" returned from a previous request to fetch the next page of filtered Recommendations that are a part of AWS IAM", + "input": { + "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBR01zYktEMDlmSm5nSkM1TGYzaWtTNkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVlwVDdDRk01cTdzV0JnRmhBZ0VRZ0R1dVg4dkVOYjZYTHJ6WVhvUlBWQVg1YU5KZkkraElsNk5lTjh3TXpzWkhHUEVzWXNkbXI2bTZzNTl1TEhKWUN2dGpqOENpTzVzM0FDT3BqZz09S35zPCUsSxxYFtdXw7z8BaSuDmz9P1Toit_MFrXsfpnPmDd6Q1f1NaJhi3O8NoZvzinXknKoKxTeqSumUaHe7W3n6Xa3661LF979aPdhifpKw3-MQpb5oGdXGgU7UMlXHzwISkND7sLlh_s0V-jkRvWPZjLHwLg4dUCQnIqMEwo5G3IG6Ffn-SKHhqPimTnzgOrxK2i9LA0EEj6msvH00h4YXuG9M3hFP9X52T19ZGZfdDPhVKCtSshXtQ8zcCUB8ykgw8ROJvAwzQk8I1PMIS4dirHySKOgoowu4Um3bZE6hHex-zXsjA==", + "awsService": "iam", + "maxResults": 1 + }, + "output": { + "recommendationSummaries": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "name": "RDS clusters quota warning", + "awsServices": [ + "rds" + ], + "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz", + "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd", + "lastUpdatedAt": "2023-11-01T15:58:17.397Z", + "pillarSpecificAggregates": { + "costOptimizing": { + "estimatedMonthlySavings": 0.0, + "estimatedPercentMonthlySavings": 0.0 + } + }, + "pillars": [ + "service_limits" + ], + "resourcesAggregates": { + "errorCount": 0, + "okCount": 0, + "warningCount": 0 + }, + "source": "ta_check", + "status": "ok", + "type": "standard" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "recommendationSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "

The type of the Recommendation

", + "smithy.api#httpQuery": "type" + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#RecommendationStatus", + "traits": { + "smithy.api#documentation": "

The status of the Recommendation

", + "smithy.api#httpQuery": "status" + } + }, + "pillar": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar", + "traits": { + "smithy.api#documentation": "

The pillar of the Recommendation

", + "smithy.api#httpQuery": "pillar" + } + }, + "awsService": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService", + "traits": { + "smithy.api#documentation": "

The aws service associated with the Recommendation

", + "smithy.api#httpQuery": "awsService" + } + }, + "source": { + "target": "com.amazonaws.trustedadvisor#RecommendationSource", + "traits": { + "smithy.api#documentation": "

The source of the Recommendation

", + "smithy.api#httpQuery": "source" + } + }, + "checkIdentifier": { + "target": "com.amazonaws.trustedadvisor#CheckIdentifier", + "traits": { + "smithy.api#documentation": "

The check identifier of the Recommendation

", + "smithy.api#httpQuery": "checkIdentifier" + } + }, + "afterLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

After the last update of the Recommendation

", + "smithy.api#httpQuery": "afterLastUpdatedAt" + } + }, + "beforeLastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Before the last update of the Recommendation

", + "smithy.api#httpQuery": "beforeLastUpdatedAt" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#ListRecommendationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request\n to retrieve the next set of results.\n

", + "smithy.api#length": { + "min": 4, + "max": 10000 + } + } + }, + "recommendationSummaries": { + "target": "com.amazonaws.trustedadvisor#RecommendationSummaryList", + "traits": { + "smithy.api#documentation": "

The list of Recommendations

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendation": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID which identifies where the Recommendation was produced

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

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

The AWS Trusted Advisor Check ARN that relates to the Recommendation

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

The status of the Recommendation

", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "

The lifecycle stage from AWS Trusted Advisor Priority

" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "

The Pillars that the Recommendation is optimizing

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

The source of the Recommendation

", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "

The AWS Services that the Recommendation applies to

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

The name of the AWS Trusted Advisor Recommendation

", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "

An aggregation of all resources

", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "

The pillar aggregations for cost savings

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

When the Recommendation was created, if created by AWS Trusted Advisor Priority

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

When the Recommendation was last updated

", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Recommendation

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

A description for AWS Trusted Advisor recommendations

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

The creator, if created by AWS Trusted Advisor Priority

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

The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information\n is only available when a Technical Account Manager takes an action on a recommendation managed by AWS\n Trusted Advisor Priority\n

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

The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation.\n This information is only available when a Technical Account Manager takes an action on a recommendation\n managed by AWS Trusted Advisor Priority\n

" + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "

Reason for the lifecycle stage change

" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "

Reason code for the lifecycle state change

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

When the Recommendation was resolved

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

A Recommendation for accounts within an Organization

" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::organization-recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor:::organization-recommendation\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Recommendation Resource

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Recommendation Resource

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

The AWS resource identifier

", + "smithy.api#required": {} + } + }, + "regionCode": { + "target": "com.amazonaws.trustedadvisor#RecommendationRegionCode", + "traits": { + "smithy.api#documentation": "

The AWS Region code that the Recommendation Resource is in

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The current status of the Recommendation Resource

", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.trustedadvisor#StringMap", + "traits": { + "smithy.api#documentation": "

Metadata associated with the Recommendation Resource

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

When the Recommendation Resource was last updated

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "accountId": { + "target": "com.amazonaws.trustedadvisor#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID

" + } + }, + "recommendationArn": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationArn", + "traits": { + "smithy.api#documentation": "

The Recommendation ARN

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

Organization Recommendation Resource Summary

" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationResourceSummary" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID which identifies where the Recommendation was produced

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

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

The AWS Trusted Advisor Check ARN that relates to the Recommendation

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

The status of the Recommendation

", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "

The lifecycle stage from AWS Trusted Advisor Priority

" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "

The Pillars that the Recommendation is optimizing

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

The source of the Recommendation

", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "

The AWS Services that the Recommendation applies to

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

The name of the AWS Trusted Advisor Recommendation

", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "

An aggregation of all resources

", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "

The pillar aggregations for cost savings

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

When the Recommendation was created, if created by AWS Trusted Advisor Priority

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

When the Recommendation was last updated

", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Recommendation

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

Summary of recommendation for accounts within an Organization

" + } + }, + "com.amazonaws.trustedadvisor#OrganizationRecommendationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationSummary" + } + }, + "com.amazonaws.trustedadvisor#Recommendation": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID which identifies where the Recommendation was produced

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

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

The AWS Trusted Advisor Check ARN that relates to the Recommendation

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

The status of the Recommendation

", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "

The lifecycle stage from AWS Trusted Advisor Priority

" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "

The Pillars that the Recommendation is optimizing

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

The source of the Recommendation

", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "

The AWS Services that the Recommendation applies to

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

The name of the AWS Trusted Advisor Recommendation

", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "

An aggregation of all resources

", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "

The pillar aggregations for cost savings

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

When the Recommendation was created, if created by AWS Trusted Advisor Priority

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

When the Recommendation was last updated

", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Recommendation

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

A description for AWS Trusted Advisor recommendations

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

The creator, if created by AWS Trusted Advisor Priority

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

The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information\n is only available when a Technical Account Manager takes an action on a recommendation managed by AWS\n Trusted Advisor Priority\n

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

The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation.\n This information is only available when a Technical Account Manager takes an action on a recommendation\n managed by AWS Trusted Advisor Priority\n

" + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "

Reason for the lifecycle stage change

" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "

Reason code for the lifecycle state change

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

When the Recommendation was resolved

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

A Recommendation for an Account

" + } + }, + "com.amazonaws.trustedadvisor#RecommendationAwsService": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 30 + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationAwsServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsService" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.trustedadvisor#RecommendationCostOptimizingAggregates": { + "type": "structure", + "members": { + "estimatedMonthlySavings": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The estimated monthly savings

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

The estimated percently monthly savings

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

Cost optimizing aggregates for a Recommendation

" + } + }, + "com.amazonaws.trustedadvisor#RecommendationLanguage": { + "type": "enum", + "members": { + "ENGLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "JAPANESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja" + } + }, + "CHINESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "FRENCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "GERMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "KOREAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko" + } + }, + "TRADITIONAL_CHINESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh_TW" + } + }, + "ITALIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "SPANISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "BRAZILIAN_PORTUGUESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt_BR" + } + }, + "BAHASA_INDONESIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "id" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationLifecycleStage": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in_progress" + } + }, + "PENDING_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_response" + } + }, + "DISMISSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dismissed" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resolved" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationPillar": { + "type": "enum", + "members": { + "COST_OPTIMIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cost_optimizing" + } + }, + "PERFORMANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance" + } + }, + "SECURITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security" + } + }, + "SERVICE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service_limits" + } + }, + "FAULT_TOLERANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fault_tolerance" + } + }, + "OPERATIONAL_EXCELLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "operational_excellence" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationPillarList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillar" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates": { + "type": "structure", + "members": { + "costOptimizing": { + "target": "com.amazonaws.trustedadvisor#RecommendationCostOptimizingAggregates", + "traits": { + "smithy.api#documentation": "

Cost optimizing aggregates

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

Recommendation pillar aggregates

" + } + }, + "com.amazonaws.trustedadvisor#RecommendationRegionCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 20 + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation-resource\\/[\\w-]+\\/[\\w-]+$" + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourceSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Recommendation Resource

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Recommendation Resource

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

The AWS resource identifier

", + "smithy.api#required": {} + } + }, + "regionCode": { + "target": "com.amazonaws.trustedadvisor#RecommendationRegionCode", + "traits": { + "smithy.api#documentation": "

The AWS Region code that the Recommendation Resource is in

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.trustedadvisor#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The current status of the Recommendation Resource

", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.trustedadvisor#StringMap", + "traits": { + "smithy.api#documentation": "

Metadata associated with the Recommendation Resource

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

When the Recommendation Resource was last updated

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "recommendationArn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "

The Recommendation ARN

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

Summary of a Recommendation Resource

" + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceSummary" + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates": { + "type": "structure", + "members": { + "okCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

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

The number of AWS resources that were flagged to have warning according to the Trusted Advisor check\n

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

The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

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

Aggregation of Recommendation Resources

" + } + }, + "com.amazonaws.trustedadvisor#RecommendationSource": { + "type": "enum", + "members": { + "AWS_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws_config" + } + }, + "COMPUTE_OPTIMIZER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compute_optimizer" + } + }, + "COST_EXPLORER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cost_explorer" + } + }, + "LSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lse" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "manual" + } + }, + "PSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pse" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rds" + } + }, + "RESILIENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resilience" + } + }, + "RESILIENCE_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resilience_hub" + } + }, + "SECURITY_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security_hub" + } + }, + "STIR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stir" + } + }, + "TA_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ta_check" + } + }, + "WELL_ARCHITECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "well_architected" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationStatus": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "warning" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationSummary": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID which identifies where the Recommendation was produced

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.trustedadvisor#RecommendationType", + "traits": { + "smithy.api#documentation": "

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

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

The AWS Trusted Advisor Check ARN that relates to the Recommendation

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

The status of the Recommendation

", + "smithy.api#required": {} + } + }, + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#RecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "

The lifecycle stage from AWS Trusted Advisor Priority

" + } + }, + "pillars": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarList", + "traits": { + "smithy.api#documentation": "

The Pillars that the Recommendation is optimizing

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

The source of the Recommendation

", + "smithy.api#required": {} + } + }, + "awsServices": { + "target": "com.amazonaws.trustedadvisor#RecommendationAwsServiceList", + "traits": { + "smithy.api#documentation": "

The AWS Services that the Recommendation applies to

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

The name of the AWS Trusted Advisor Recommendation

", + "smithy.api#required": {} + } + }, + "resourcesAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourcesAggregates", + "traits": { + "smithy.api#documentation": "

An aggregation of all resources

", + "smithy.api#required": {} + } + }, + "pillarSpecificAggregates": { + "target": "com.amazonaws.trustedadvisor#RecommendationPillarSpecificAggregates", + "traits": { + "smithy.api#documentation": "

The pillar aggregations for cost savings

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

When the Recommendation was created, if created by AWS Trusted Advisor Priority

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

When the Recommendation was last updated

", + "smithy.api#timestampFormat": "date-time" + } + }, + "arn": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Recommendation

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

Summary of Recommendation for an Account

" + } + }, + "com.amazonaws.trustedadvisor#RecommendationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationSummary" + } + }, + "com.amazonaws.trustedadvisor#RecommendationType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "PRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "priority" + } + } + } + }, + "com.amazonaws.trustedadvisor#RecommendationUpdateReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.trustedadvisor#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Exception that the requested resource has not been found

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.trustedadvisor#ResourceStatus": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "warning" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.trustedadvisor#StringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.trustedadvisor#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Exception to notify that requests are being throttled

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.trustedadvisor#TrustedAdvisor": { + "type": "service", + "version": "2022-09-15", + "operations": [ + { + "target": "com.amazonaws.trustedadvisor#GetOrganizationRecommendation" + }, + { + "target": "com.amazonaws.trustedadvisor#GetRecommendation" + }, + { + "target": "com.amazonaws.trustedadvisor#ListChecks" + }, + { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationAccounts" + }, + { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendationResources" + }, + { + "target": "com.amazonaws.trustedadvisor#ListOrganizationRecommendations" + }, + { + "target": "com.amazonaws.trustedadvisor#ListRecommendationResources" + }, + { + "target": "com.amazonaws.trustedadvisor#ListRecommendations" + }, + { + "target": "com.amazonaws.trustedadvisor#UpdateOrganizationRecommendationLifecycle" + }, + { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycle" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "TrustedAdvisor", + "arnNamespace": "trustedadvisor", + "cloudTrailEventSource": "trustedadvisor.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "trustedadvisor" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "amz-sdk-invocation-id", + "amz-sdk-request", + "authorization", + "content-length", + "content-type", + "date", + "retry-after", + "x-amz-apigw-id", + "x-amz-cf-id", + "x-amz-content-sha256", + "x-amz-date", + "x-amz-security-token", + "x-amz-target", + "x-amz-user-agent", + "x-amzn-errormessage", + "x-amzn-errortype", + "x-amzn-platform-id", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amzn-waf-action", + "x-api-key" + ], + "additionalExposedHeaders": [ + "date", + "retry-after", + "x-amz-apigw-id", + "x-amz-cf-id", + "x-amzn-errormessage", + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amzn-waf-action" + ] + }, + "smithy.api#documentation": "

TrustedAdvisor Public API

", + "smithy.api#title": "TrustedAdvisor Public API", + "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://trustedadvisor-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://trustedadvisor-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://trustedadvisor.{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://trustedadvisor.{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://trustedadvisor-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://trustedadvisor-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://trustedadvisor.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://trustedadvisor.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://trustedadvisor-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://trustedadvisor-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://trustedadvisor.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://trustedadvisor.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://trustedadvisor-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://trustedadvisor-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://trustedadvisor.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://trustedadvisor.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://trustedadvisor-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://trustedadvisor.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://trustedadvisor-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://trustedadvisor.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.trustedadvisor#UpdateOrganizationRecommendationLifecycle": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#UpdateOrganizationRecommendationLifecycleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#ConflictException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the lifecyle of a Recommendation within an Organization. This API only supports prioritized\n recommendations.\n

", + "smithy.api#examples": [ + { + "title": "Update the lifecycle stage of an AWS Organization's Recommendation that is managed by AWS Trusted Advisor Priority", + "input": { + "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/96b5e5ca-7930-444c-90c6-06d386128100", + "lifecycleStage": "dismissed", + "updateReasonCode": "not_applicable", + "updateReason": "Does not apply to this resource" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/organization-recommendations/{organizationRecommendationIdentifier}/lifecycle", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#UpdateOrganizationRecommendationLifecycleRequest": { + "type": "structure", + "members": { + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "

The new lifecycle stage

", + "smithy.api#required": {} + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "

Reason for the lifecycle stage change

" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "

Reason code for the lifecycle state change

" + } + }, + "organizationRecommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#OrganizationRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "

The Recommendation identifier for AWS Trusted Advisor Priority recommendations

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycle": { + "type": "operation", + "input": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.trustedadvisor#AccessDeniedException" + }, + { + "target": "com.amazonaws.trustedadvisor#ConflictException" + }, + { + "target": "com.amazonaws.trustedadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.trustedadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.trustedadvisor#ThrottlingException" + }, + { + "target": "com.amazonaws.trustedadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.

", + "smithy.api#examples": [ + { + "title": "Update the lifecycle stage of a Recommendation managed by AWS Trusted Advisor Priority", + "input": { + "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/861c9c6e-f169-405a-8b59-537a8caccd7a", + "lifecycleStage": "resolved", + "updateReasonCode": "valid_business_case", + "updateReason": "Resolved the recommendation" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/recommendations/{recommendationIdentifier}/lifecycle", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleRequest": { + "type": "structure", + "members": { + "lifecycleStage": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStage", + "traits": { + "smithy.api#documentation": "

The new lifecycle stage

", + "smithy.api#required": {} + } + }, + "updateReason": { + "target": "com.amazonaws.trustedadvisor#RecommendationUpdateReason", + "traits": { + "smithy.api#documentation": "

Reason for the lifecycle stage change

" + } + }, + "updateReasonCode": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode", + "traits": { + "smithy.api#documentation": "

Reason code for the lifecycle state change

" + } + }, + "recommendationIdentifier": { + "target": "com.amazonaws.trustedadvisor#AccountRecommendationIdentifier", + "traits": { + "smithy.api#documentation": "

The Recommendation identifier for AWS Trusted Advisor Priority recommendations

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStage": { + "type": "enum", + "members": { + "PENDING_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_response" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in_progress" + } + }, + "DISMISSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dismissed" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resolved" + } + } + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationLifecycleStageReasonCode": { + "type": "enum", + "members": { + "NON_CRITICAL_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "non_critical_account" + } + }, + "TEMPORARY_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary_account" + } + }, + "VALID_BUSINESS_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "valid_business_case" + } + }, + "OTHER_METHODS_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other_methods_available" + } + }, + "LOW_PRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "low_priority" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not_applicable" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + }, + "com.amazonaws.trustedadvisor#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Exception that the request failed to satisfy service constraints

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/verifiedpermissions.json b/codegen/sdk-codegen/aws-models/verifiedpermissions.json index 0c51bd2401a..451b6992e0a 100644 --- a/codegen/sdk-codegen/aws-models/verifiedpermissions.json +++ b/codegen/sdk-codegen/aws-models/verifiedpermissions.json @@ -47,7 +47,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about an action for a request for which an authorization decision\n is made.

\n

This data type is used as an request parameter to the IsAuthorized and IsAuthorizedWithToken operations.

\n

Example: { \"actionId\": \"<action name>\", \"actionType\": \"Action\"\n }\n

" + "smithy.api#documentation": "

Contains information about an action for a request for which an authorization decision\n is made.

\n

This data type is used as a request parameter to the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.

\n

Example: { \"actionId\": \"<action name>\", \"actionType\": \"Action\"\n }\n

" } }, "com.amazonaws.verifiedpermissions#ActionType": { @@ -67,7 +67,7 @@ "boolean": { "target": "com.amazonaws.verifiedpermissions#BooleanAttribute", "traits": { - "smithy.api#documentation": "

An attribute value of Boolean type.

\n

Example: {\"boolean\": true}\n

" + "smithy.api#documentation": "

An attribute value of Boolean\n type.

\n

Example: {\"boolean\": true}\n

" } }, "entityIdentifier": { @@ -85,7 +85,7 @@ "string": { "target": "com.amazonaws.verifiedpermissions#StringAttribute", "traits": { - "smithy.api#documentation": "

An attribute value of String type.

\n

Example: {\"string\": \"abc\"}\n

" + "smithy.api#documentation": "

An attribute value of String\n type.

\n

Example: {\"string\": \"abc\"}\n

" } }, "set": { @@ -97,12 +97,160 @@ "record": { "target": "com.amazonaws.verifiedpermissions#RecordAttribute", "traits": { - "smithy.api#documentation": "

An attribute value of Record type.

\n

Example: {\"record\": { \"keyName\": {} } }\n

" + "smithy.api#documentation": "

An attribute value of Record\n type.

\n

Example: {\"record\": { \"keyName\": {} } }\n

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

The value of an attribute.

\n

Contains information about the runtime context for a request for which an\n authorization decision is made.

\n

This data type is used as a member of the ContextDefinition structure\n which is uses as a request parameter for the IsAuthorized and IsAuthorizedWithToken operations.

" + "smithy.api#documentation": "

The value of an attribute.

\n

Contains information about the runtime context for a request for which an\n authorization decision is made.

\n

This data type is used as a member of the ContextDefinition structure\n which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.

" + } + }, + "com.amazonaws.verifiedpermissions#BatchIsAuthorized": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorizedInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorizedOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionName": "IsAuthorized", + "aws.iam#actionPermissionDescription": "Grants permission to make a batch authorization decision about a service request described in the parameters", + "smithy.api#documentation": "

Makes a series of decisions about multiple authorization requests for one principal or\n resource. Each request contains the equivalent content of an IsAuthorized\n request: principal, action, resource, and context. Either the principal or\n the resource parameter must be identical across all requests. For example,\n Verified Permissions won't evaluate a pair of requests where bob views\n photo1 and alice views photo2. Authorization\n of bob to view photo1 and photo2, or\n bob and alice to view photo1, are valid\n batches.

\n

The request is evaluated against all policies in the specified policy store that match the\n entities that you declare. The result of the decisions is a series of Allow\n or Deny responses, along with the IDs of the policies that produced each\n decision.

\n

The entities of a BatchIsAuthorized API request can contain up to 100 principals and up\n to 100 resources. The requests of a BatchIsAuthorized API request can contain up to 30\n requests.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#BatchIsAuthorizedInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store. Policies in this policy store will be used to make the\n authorization decisions for the input.

", + "smithy.api#required": {} + } + }, + "entities": { + "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", + "traits": { + "smithy.api#documentation": "

Specifies the list of resources and principals and their associated attributes that\n Verified Permissions can examine when evaluating the policies.

\n \n

You can include only principal and resource entities in this parameter; you can't\n include actions. You must specify actions in the schema.

\n " + } + }, + "requests": { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorizedInputList", + "traits": { + "smithy.api#documentation": "

An array of up to 30 requests that you want Verified Permissions to evaluate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#BatchIsAuthorizedInputItem": { + "type": "structure", + "members": { + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the principal for which the authorization decision is to be made.

" + } + }, + "action": { + "target": "com.amazonaws.verifiedpermissions#ActionIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the requested action to be authorized. For example, is the principal\n authorized to perform this action on the resource?

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the resource for which the authorization decision is to be made.

" + } + }, + "context": { + "target": "com.amazonaws.verifiedpermissions#ContextDefinition", + "traits": { + "smithy.api#documentation": "

Specifies additional context that can be used to make more granular authorization\n decisions.

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

An authorization request that you include in a BatchIsAuthorized API\n request.

" + } + }, + "com.amazonaws.verifiedpermissions#BatchIsAuthorizedInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorizedInputItem" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.verifiedpermissions#BatchIsAuthorizedOutput": { + "type": "structure", + "members": { + "results": { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorizedOutputList", + "traits": { + "smithy.api#documentation": "

A series of Allow or Deny decisions for each request, and\n the policies that produced them.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#BatchIsAuthorizedOutputItem": { + "type": "structure", + "members": { + "request": { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorizedInputItem", + "traits": { + "smithy.api#documentation": "

The authorization request that initiated the decision.

", + "smithy.api#required": {} + } + }, + "decision": { + "target": "com.amazonaws.verifiedpermissions#Decision", + "traits": { + "smithy.api#documentation": "

An authorization decision that indicates if the authorization request should be\n allowed or denied.

", + "smithy.api#required": {} + } + }, + "determiningPolicies": { + "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", + "traits": { + "smithy.api#documentation": "

The list of determining policies used to make the authorization decision. For example,\n if there are two matching policies, where one is a forbid and the other is a permit,\n then the forbid policy will be the determining policy. In the case of multiple matching\n permit policies then there would be multiple determining policies. In the case that no\n policies match, and hence the response is DENY, there would be no determining\n policies.

", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", + "traits": { + "smithy.api#documentation": "

Errors that occurred while making an authorization decision, for example, a policy\n references an Entity or entity Attribute that does not exist in the slice.

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

The decision, based on policy evaluation, from an individual authorization request in\n a BatchIsAuthorized API request.

" + } + }, + "com.amazonaws.verifiedpermissions#BatchIsAuthorizedOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorizedOutputItem" } }, "com.amazonaws.verifiedpermissions#BooleanAttribute": { @@ -198,12 +346,12 @@ "contextMap": { "target": "com.amazonaws.verifiedpermissions#ContextMap", "traits": { - "smithy.api#documentation": "

An list of attributes that are needed to successfully evaluate an authorization\n request. Each attribute in this array must include a map of a data type and its\n value.

\n

Example:\n \"Context\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}\n

" + "smithy.api#documentation": "

An list of attributes that are needed to successfully evaluate an authorization\n request. Each attribute in this array must include a map of a data type and its\n value.

\n

Example:\n \"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}\n

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

Contains additional details about the context of the request. Verified Permissions evaluates this\n information in an authorization request as part of the when and\n unless clauses in a policy.

\n

This data type is used as a request parameter for the IsAuthorized and IsAuthorizedWithToken operations.

\n

Example:\n \"context\":{\"Context\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}\n

" + "smithy.api#documentation": "

Contains additional details about the context of the request. Verified Permissions evaluates this\n information in an authorization request as part of the when and\n unless clauses in a policy.

\n

This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.

\n

Example:\n \"context\":{\"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}\n

" } }, "com.amazonaws.verifiedpermissions#ContextMap": { @@ -814,7 +962,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about one of the policies that determined an authorization\n decision.

\n

This data type is used as an element in a response parameter for the IsAuthorized\n and IsAuthorizedWithToken operations.

\n

Example: \"determiningPolicies\":[{\"policyId\":\"SPEXAMPLEabcdefg111111\"}]\n

" + "smithy.api#documentation": "

Contains information about one of the policies that determined an authorization\n decision.

\n

This data type is used as an element in a response parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.

\n

Example: \"determiningPolicies\":[{\"policyId\":\"SPEXAMPLEabcdefg111111\"}]\n

" } }, "com.amazonaws.verifiedpermissions#DeterminingPolicyList": { @@ -968,7 +1116,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains a description of an evaluation error.

\n

This data type is used as a request parameter in the IsAuthorized and IsAuthorizedWithToken operations.

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

Contains a description of an evaluation error.

\n

This data type is a response parameter of the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

", "smithy.api#sensitive": {} } }, @@ -2425,6 +2573,9 @@ "target": "com.amazonaws.verifiedpermissions#ListPolicyStores" }, "operations": [ + { + "target": "com.amazonaws.verifiedpermissions#BatchIsAuthorized" + }, { "target": "com.amazonaws.verifiedpermissions#GetSchema" }, @@ -2847,7 +2998,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 10000 + "max": 100000 }, "smithy.api#sensitive": {} } diff --git a/codegen/sdk-codegen/aws-models/wisdom.json b/codegen/sdk-codegen/aws-models/wisdom.json index 67191c46924..0de94c13989 100644 --- a/codegen/sdk-codegen/aws-models/wisdom.json +++ b/codegen/sdk-codegen/aws-models/wisdom.json @@ -187,7 +187,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

" } } }, @@ -329,7 +329,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant\n and kms:DescribeKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey \n permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" } }, "integrationConfiguration": { @@ -447,7 +447,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant\n and kms:DescribeKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" } }, "integrationConfiguration": { @@ -483,6 +483,25 @@ ] } }, + "com.amazonaws.wisdom#Channel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.wisdom#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#Channel" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.wisdom#ClientToken": { "type": "string", "traits": { @@ -492,6 +511,20 @@ } } }, + "com.amazonaws.wisdom#Configuration": { + "type": "union", + "members": { + "connectConfiguration": { + "target": "com.amazonaws.wisdom#ConnectConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the Amazon Connect data source.

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

The configuration information of the external data source.

" + } + }, "com.amazonaws.wisdom#ConflictException": { "type": "structure", "members": { @@ -505,6 +538,48 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.wisdom#ConnectConfiguration": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.wisdom#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The configuration information of the Amazon Connect data source.

" + } + }, + "com.amazonaws.wisdom#ContactAttributeKey": { + "type": "string" + }, + "com.amazonaws.wisdom#ContactAttributeKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#ContactAttributeKey" + }, + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.wisdom#ContactAttributeValue": { + "type": "string" + }, + "com.amazonaws.wisdom#ContactAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.wisdom#ContactAttributeKey" + }, + "value": { + "target": "com.amazonaws.wisdom#ContactAttributeValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.wisdom#Content": { "type": "resource", "identifiers": { @@ -569,7 +644,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", "smithy.api#required": {} } }, @@ -682,7 +757,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

" } }, "contentArn": { @@ -764,7 +839,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", "smithy.api#required": {} } }, @@ -847,7 +922,7 @@ "com.amazonaws.wisdom#ContentType": { "type": "string", "traits": { - "smithy.api#pattern": "^(text/(plain|html))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + "smithy.api#pattern": "^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" } }, "com.amazonaws.wisdom#CreateAssistant": { @@ -1005,7 +1080,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

The customer managed key must have a policy that allows kms:CreateGrant\n and kms:DescribeKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

The customer managed key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" } } } @@ -1061,7 +1136,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1194,7 +1269,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant\n and kms:DescribeKey permissions to the IAM identity using the key\n to invoke Wisdom.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" } }, "description": { @@ -1222,6 +1297,139 @@ } } }, + "com.amazonaws.wisdom#CreateQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#CreateQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#CreateQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ConflictException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Wisdom quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.wisdom#CreateQuickResponseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.wisdom#QuickResponseName", + "traits": { + "smithy.api#documentation": "

The name of the quick response.

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

The content of the quick response.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.wisdom#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n
    \n
  • \n

    Use application/x.quickresponse;format=plain for a quick response written in plain text.

    \n
    • \n
  • \n

    Use application/x.quickresponse;format=markdown for a quick response written in richtext.

    \n
    • \n
" + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.wisdom#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the user groups that the quick response is accessible to.

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

The description of the quick response.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.wisdom#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.\n

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.wisdom#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect channels this quick response applies to.

" + } + }, + "language": { + "target": "com.amazonaws.wisdom#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.wisdom#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#CreateQuickResponseResponse": { + "type": "structure", + "members": { + "quickResponse": { + "target": "com.amazonaws.wisdom#QuickResponseData", + "traits": { + "smithy.api#documentation": "

The quick response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#CreateSession": { "type": "operation", "input": { @@ -1435,7 +1643,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1454,6 +1662,69 @@ "type": "structure", "members": {} }, + "com.amazonaws.wisdom#DeleteImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#DeleteImportJobRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#DeleteImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ConflictException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the quick response import job.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.wisdom#DeleteImportJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "importJobId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the import job to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#DeleteImportJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#DeleteKnowledgeBase": { "type": "operation", "input": { @@ -1503,6 +1774,66 @@ "type": "structure", "members": {} }, + "com.amazonaws.wisdom#DeleteQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#DeleteQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#DeleteQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.wisdom#DeleteQuickResponseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#DeleteQuickResponseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#Description": { "type": "string", "traits": { @@ -1560,14 +1891,47 @@ "smithy.api#documentation": "

The text of the document.

" } }, - "com.amazonaws.wisdom#Filter": { - "type": "structure", - "members": { - "field": { - "target": "com.amazonaws.wisdom#FilterField", - "traits": { - "smithy.api#documentation": "

The field on which to filter.

", - "smithy.api#required": {} + "com.amazonaws.wisdom#ExternalSource": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AMAZON_CONNECT", + "name": "AMAZON_CONNECT" + } + ] + } + }, + "com.amazonaws.wisdom#ExternalSourceConfiguration": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.wisdom#ExternalSource", + "traits": { + "smithy.api#documentation": "

The type of the external data source.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.wisdom#Configuration", + "traits": { + "smithy.api#documentation": "

The configuration information of the external data source.

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

The configuration information of the external data source.

" + } + }, + "com.amazonaws.wisdom#Filter": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.wisdom#FilterField", + "traits": { + "smithy.api#documentation": "

The field on which to filter.

", + "smithy.api#required": {} } }, "operator": { @@ -1781,7 +2145,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1841,7 +2205,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1859,6 +2223,72 @@ } } }, + "com.amazonaws.wisdom#GetImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#GetImportJobRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#GetImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the started import job.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.wisdom#GetImportJobRequest": { + "type": "structure", + "members": { + "importJobId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the import job to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base that the import job belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#GetImportJobResponse": { + "type": "structure", + "members": { + "importJob": { + "target": "com.amazonaws.wisdom#ImportJobData", + "traits": { + "smithy.api#documentation": "

The import job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#GetKnowledgeBase": { "type": "operation", "input": { @@ -1893,7 +2323,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1911,6 +2341,72 @@ } } }, + "com.amazonaws.wisdom#GetQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#GetQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#GetQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.wisdom#GetQuickResponseRequest": { + "type": "structure", + "members": { + "quickResponseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#GetQuickResponseResponse": { + "type": "structure", + "members": { + "quickResponse": { + "target": "com.amazonaws.wisdom#QuickResponseData", + "traits": { + "smithy.api#documentation": "

The quick response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#GetRecommendations": { "type": "operation", "input": { @@ -2053,6 +2549,55 @@ } } }, + "com.amazonaws.wisdom#GroupingConfiguration": { + "type": "structure", + "members": { + "criteria": { + "target": "com.amazonaws.wisdom#GroupingCriteria", + "traits": { + "smithy.api#documentation": "

The criteria used for grouping Wisdom users.

\n

The following is the list of supported criteria values.

\n " + } + }, + "values": { + "target": "com.amazonaws.wisdom#GroupingValues", + "traits": { + "smithy.api#documentation": "

The list of values that define different groups of Wisdom users.

\n
    \n
  • \n

    When setting criteria to RoutingProfileArn, you need to provide a list of\n ARNs of Amazon Connect routing profiles as values of this parameter.

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

The configuration information of the grouping of Wisdom users.

" + } + }, + "com.amazonaws.wisdom#GroupingCriteria": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.wisdom#GroupingValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.wisdom#GroupingValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#GroupingValue" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.wisdom#Headers": { "type": "map", "key": { @@ -2096,79 +2641,27 @@ "target": "com.amazonaws.wisdom#Highlight" } }, - "com.amazonaws.wisdom#KnowledgeBase": { - "type": "resource", - "identifiers": { - "knowledgeBaseId": { - "target": "com.amazonaws.wisdom#UuidOrArn" - } - }, - "create": { - "target": "com.amazonaws.wisdom#CreateKnowledgeBase" - }, - "read": { - "target": "com.amazonaws.wisdom#GetKnowledgeBase" - }, - "delete": { - "target": "com.amazonaws.wisdom#DeleteKnowledgeBase" - }, - "list": { - "target": "com.amazonaws.wisdom#ListKnowledgeBases" - }, - "operations": [ - { - "target": "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUri" - }, - { - "target": "com.amazonaws.wisdom#SearchContent" - }, - { - "target": "com.amazonaws.wisdom#StartContentUpload" - }, - { - "target": "com.amazonaws.wisdom#UpdateKnowledgeBaseTemplateUri" - } - ], - "resources": [ - { - "target": "com.amazonaws.wisdom#Content" - } - ], - "traits": { - "aws.api#arn": { - "template": "knowledge-base/{knowledgeBaseId}" - }, - "aws.cloudformation#cfnResource": {}, - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.wisdom#KnowledgeBaseAssociationData": { + "com.amazonaws.wisdom#ImportJobData": { "type": "structure", "members": { - "knowledgeBaseId": { + "importJobId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the import job.

", + "smithy.api#required": {} } }, - "knowledgeBaseArn": { - "target": "com.amazonaws.wisdom#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

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

Association information about the knowledge base.

" - } - }, - "com.amazonaws.wisdom#KnowledgeBaseData": { - "type": "structure", - "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.wisdom#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.

", "smithy.api#required": {} } }, @@ -2179,32 +2672,324 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.wisdom#Name", + "importJobType": { + "target": "com.amazonaws.wisdom#ImportJobType", "traits": { - "smithy.api#documentation": "

The name of the knowledge base.

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

The type of the import job.

", "smithy.api#required": {} } }, - "knowledgeBaseType": { - "target": "com.amazonaws.wisdom#KnowledgeBaseType", + "status": { + "target": "com.amazonaws.wisdom#ImportJobStatus", "traits": { - "smithy.api#documentation": "

The type of knowledge base.

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

The status of the import job.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.wisdom#KnowledgeBaseStatus", + "url": { + "target": "com.amazonaws.wisdom#Url", "traits": { - "smithy.api#documentation": "

The status of the knowledge base.

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

The download link to the resource file that is uploaded to the import job.

", "smithy.api#required": {} } }, - "lastContentModificationTime": { - "target": "smithy.api#Timestamp", + "failedRecordReport": { + "target": "com.amazonaws.wisdom#Url", "traits": { - "smithy.api#documentation": "

An epoch timestamp indicating the most recent content modification inside the knowledge\n base. If no content exists in a knowledge base, this value is unset.

", - "smithy.api#timestampFormat": "epoch-seconds" + "smithy.api#documentation": "

The link to donwload the information of resource data that failed to be imported.

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

The expiration time of the URL as an epoch timestamp.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the import job was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the import job data was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "metadata": { + "target": "com.amazonaws.wisdom#ContentMetadata", + "traits": { + "smithy.api#documentation": "

The metadata fields of the imported Wisdom resources.

" + } + }, + "externalSourceConfiguration": { + "target": "com.amazonaws.wisdom#ExternalSourceConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about the import job.

" + } + }, + "com.amazonaws.wisdom#ImportJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#ImportJobSummary" + } + }, + "com.amazonaws.wisdom#ImportJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "START_IN_PROGRESS", + "name": "START_IN_PROGRESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.wisdom#ImportJobSummary": { + "type": "structure", + "members": { + "importJobId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the import job.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.wisdom#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.wisdom#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "importJobType": { + "target": "com.amazonaws.wisdom#ImportJobType", + "traits": { + "smithy.api#documentation": "

The type of import job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.wisdom#ImportJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the import job.

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

The timestamp when the import job was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the import job was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "metadata": { + "target": "com.amazonaws.wisdom#ContentMetadata", + "traits": { + "smithy.api#documentation": "

The metadata fields of the imported Wisdom resources.

" + } + }, + "externalSourceConfiguration": { + "target": "com.amazonaws.wisdom#ExternalSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the external source that the resource data are imported from.

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

Summary information about the import job.

" + } + }, + "com.amazonaws.wisdom#ImportJobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUICK_RESPONSES", + "name": "QUICK_RESPONSES" + } + ] + } + }, + "com.amazonaws.wisdom#KnowledgeBase": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.wisdom#CreateKnowledgeBase" + }, + "read": { + "target": "com.amazonaws.wisdom#GetKnowledgeBase" + }, + "delete": { + "target": "com.amazonaws.wisdom#DeleteKnowledgeBase" + }, + "list": { + "target": "com.amazonaws.wisdom#ListKnowledgeBases" + }, + "operations": [ + { + "target": "com.amazonaws.wisdom#DeleteImportJob" + }, + { + "target": "com.amazonaws.wisdom#GetImportJob" + }, + { + "target": "com.amazonaws.wisdom#ListImportJobs" + }, + { + "target": "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUri" + }, + { + "target": "com.amazonaws.wisdom#SearchContent" + }, + { + "target": "com.amazonaws.wisdom#SearchQuickResponses" + }, + { + "target": "com.amazonaws.wisdom#StartContentUpload" + }, + { + "target": "com.amazonaws.wisdom#StartImportJob" + }, + { + "target": "com.amazonaws.wisdom#UpdateKnowledgeBaseTemplateUri" + } + ], + "resources": [ + { + "target": "com.amazonaws.wisdom#Content" + }, + { + "target": "com.amazonaws.wisdom#QuickResponse" + } + ], + "traits": { + "aws.api#arn": { + "template": "knowledge-base/{knowledgeBaseId}" + }, + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.wisdom#KnowledgeBaseAssociationData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

" + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.wisdom#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

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

Association information about the knowledge base.

" + } + }, + "com.amazonaws.wisdom#KnowledgeBaseData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.wisdom#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

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

The name of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseType": { + "target": "com.amazonaws.wisdom#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "

The type of knowledge base.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.wisdom#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "

The status of the knowledge base.

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

An epoch timestamp indicating the most recent content modification inside the knowledge\n base. If no content exists in a knowledge base, this value is unset.

", + "smithy.api#timestampFormat": "epoch-seconds" } }, "sourceConfiguration": { @@ -2222,7 +3007,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant\n and kms:DescribeKey permissions to the IAM identity using the key\n to invoke Wisdom.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant, \n kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" } }, "description": { @@ -2290,7 +3075,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

", "smithy.api#required": {} } }, @@ -2337,7 +3122,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant\n and kms:DescribeKey permissions to the IAM identity using the key\n to invoke Wisdom.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant, \n kms:DescribeKey, kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom.

\n

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.

" } }, "description": { @@ -2373,10 +3158,23 @@ { "value": "CUSTOM", "name": "CUSTOM" + }, + { + "value": "QUICK_RESPONSES", + "name": "QUICK_RESPONSES" } ] } }, + "com.amazonaws.wisdom#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 5 + } + } + }, "com.amazonaws.wisdom#ListAssistantAssociations": { "type": "operation", "input": { @@ -2578,7 +3376,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2603,7 +3401,89 @@ } } }, - "com.amazonaws.wisdom#ListKnowledgeBases": { + "com.amazonaws.wisdom#ListImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#ListImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#ListImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about import jobs.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "importJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.wisdom#ListImportJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.wisdom#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

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

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#ListImportJobsResponse": { + "type": "structure", + "members": { + "importJobSummaries": { + "target": "com.amazonaws.wisdom#ImportJobList", + "traits": { + "smithy.api#documentation": "

Summary information about the import jobs.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wisdom#ListKnowledgeBases": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListKnowledgeBasesRequest" @@ -2671,6 +3551,91 @@ } } }, + "com.amazonaws.wisdom#ListQuickResponses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#ListQuickResponsesRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#ListQuickResponsesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "quickResponseSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.wisdom#ListQuickResponsesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.wisdom#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

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

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#ListQuickResponsesResponse": { + "type": "structure", + "members": { + "quickResponseSummaries": { + "target": "com.amazonaws.wisdom#QuickResponseSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about the quick responses.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#ListTagsForResource": { "type": "operation", "input": { @@ -2868,6 +3833,21 @@ } } }, + "com.amazonaws.wisdom#Order": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, "com.amazonaws.wisdom#PreconditionFailedException": { "type": "structure", "members": { @@ -2881,6 +3861,25 @@ "smithy.api#httpError": 412 } }, + "com.amazonaws.wisdom#Priority": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "LOW", + "name": "LOW" + } + ] + } + }, "com.amazonaws.wisdom#QueryAssistant": { "type": "operation", "input": { @@ -2893,6 +3892,9 @@ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, + { + "target": "com.amazonaws.wisdom#RequestTimeoutException" + }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, @@ -2994,49 +3996,823 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.wisdom#RecommendationData": { + "com.amazonaws.wisdom#QuickResponse": { + "type": "resource", + "identifiers": { + "quickResponseId": { + "target": "com.amazonaws.wisdom#UuidOrArn" + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.wisdom#CreateQuickResponse" + }, + "read": { + "target": "com.amazonaws.wisdom#GetQuickResponse" + }, + "update": { + "target": "com.amazonaws.wisdom#UpdateQuickResponse" + }, + "delete": { + "target": "com.amazonaws.wisdom#DeleteQuickResponse" + }, + "list": { + "target": "com.amazonaws.wisdom#ListQuickResponses" + }, + "traits": { + "aws.api#arn": { + "template": "quick-response/{knowledgeBaseId}/{quickResponseId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.wisdom#QuickResponseContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.wisdom#QuickResponseContentProvider": { + "type": "union", + "members": { + "content": { + "target": "com.amazonaws.wisdom#QuickResponseContent", + "traits": { + "smithy.api#documentation": "

The content of the quick response.

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

The container quick response content.

" + } + }, + "com.amazonaws.wisdom#QuickResponseContents": { "type": "structure", "members": { - "recommendationId": { - "target": "smithy.api#String", + "plainText": { + "target": "com.amazonaws.wisdom#QuickResponseContentProvider" + }, + "markdown": { + "target": "com.amazonaws.wisdom#QuickResponseContentProvider" + } + }, + "traits": { + "smithy.api#documentation": "

The content of the quick response stored in different media types.

" + } + }, + "com.amazonaws.wisdom#QuickResponseData": { + "type": "structure", + "members": { + "quickResponseArn": { + "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The identifier of the recommendation.

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

The Amazon Resource Name (ARN) of the quick response.

", "smithy.api#required": {} } }, - "document": { - "target": "com.amazonaws.wisdom#Document", + "quickResponseId": { + "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The recommended document.

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

The identifier of the quick response.

", "smithy.api#required": {} } }, - "relevanceScore": { - "target": "com.amazonaws.wisdom#RelevanceScore", + "knowledgeBaseArn": { + "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The relevance score of the recommendation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} } }, - "relevanceLevel": { - "target": "com.amazonaws.wisdom#RelevanceLevel", + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The relevance level of the recommendation.

" + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.wisdom#RecommendationType", + "name": { + "target": "com.amazonaws.wisdom#QuickResponseName", "traits": { - "smithy.api#documentation": "

The type of recommendation.

" + "smithy.api#documentation": "

The name of the quick response.

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

Information about the recommendation.

" - } - }, - "com.amazonaws.wisdom#RecommendationIdList": { - "type": "list", + }, + "contentType": { + "target": "com.amazonaws.wisdom#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n
    \n
  • \n

    Use application/x.quickresponse;format=plain for quick response written in plain text.

    \n
    • \n
  • \n

    Use application/x.quickresponse;format=markdown for quick response written in richtext.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.wisdom#QuickResponseStatus", + "traits": { + "smithy.api#documentation": "

The status of the quick response data.

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

The timestamp when the quick response was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the quick response data was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "contents": { + "target": "com.amazonaws.wisdom#QuickResponseContents", + "traits": { + "smithy.api#documentation": "

The contents of the quick response.

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

The description of the quick response.

" + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.wisdom#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the user groups that the quick response is accessible to.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.wisdom#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.

" + } + }, + "lastModifiedBy": { + "target": "com.amazonaws.wisdom#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.wisdom#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + } + }, + "language": { + "target": "com.amazonaws.wisdom#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code value for the language in which the quick response is written.

" + } + }, + "tags": { + "target": "com.amazonaws.wisdom#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

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

Information about the quick response.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.wisdom#QuickResponse" + }, + { + "resource": "com.amazonaws.wisdom#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.wisdom#QuickResponseDataProvider": { + "type": "union", + "members": { + "content": { + "target": "com.amazonaws.wisdom#QuickResponseContent", + "traits": { + "smithy.api#documentation": "

The content of the quick response.

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

The container of quick response data.

" + } + }, + "com.amazonaws.wisdom#QuickResponseDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.wisdom#QuickResponseFilterField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.wisdom#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute field to filter the quick responses by.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.wisdom#QuickResponseFilterValueList", + "traits": { + "smithy.api#documentation": "

The values of attribute field to filter the quick response by.

" + } + }, + "operator": { + "target": "com.amazonaws.wisdom#QuickResponseFilterOperator", + "traits": { + "smithy.api#documentation": "

The operator to use for filtering.

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

Whether to treat null value as a match for the attribute field.

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

The quick response fields to filter the quick response query results by.

\n

The following is the list of supported field names.

\n
    \n
  • \n

    name

    \n
    • \n
  • \n

    description

    \n
    • \n
  • \n

    shortcutKey

    \n
    • \n
  • \n

    isActive

    \n
    • \n
  • \n

    channels

    \n
    • \n
  • \n

    language

    \n
    • \n
  • \n

    contentType

    \n
    • \n
  • \n

    createdTime

    \n
    • \n
  • \n

    lastModifiedTime

    \n
    • \n
  • \n

    lastModifiedBy

    \n
    • \n
  • \n

    groupingConfiguration.criteria

    \n
    • \n
  • \n

    groupingConfiguration.values

    \n
    • \n
" + } + }, + "com.amazonaws.wisdom#QuickResponseFilterFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#QuickResponseFilterField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.wisdom#QuickResponseFilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "PREFIX", + "name": "PREFIX" + } + ] + } + }, + "com.amazonaws.wisdom#QuickResponseFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wisdom#QuickResponseFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#QuickResponseFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.wisdom#QuickResponseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.wisdom#QuickResponseOrderField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.wisdom#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute to order the quick response query results by.

", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.wisdom#Order", + "traits": { + "smithy.api#documentation": "

The order at which the quick responses are sorted by.

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

The quick response fields to order the quick response query results by.

\n

The following is the list of supported field names.

\n
    \n
  • \n

    name

    \n
    • \n
  • \n

    description

    \n
    • \n
  • \n

    shortcutKey

    \n
    • \n
  • \n

    isActive

    \n
    • \n
  • \n

    channels

    \n
    • \n
  • \n

    language

    \n
    • \n
  • \n

    contentType

    \n
    • \n
  • \n

    createdTime

    \n
    • \n
  • \n

    lastModifiedTime

    \n
    • \n
  • \n

    lastModifiedBy

    \n
    • \n
  • \n

    groupingConfiguration.criteria

    \n
    • \n
  • \n

    groupingConfiguration.values

    \n
    • \n
" + } + }, + "com.amazonaws.wisdom#QuickResponseQueryField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.wisdom#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute to query the quick responses by.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.wisdom#QuickResponseQueryValueList", + "traits": { + "smithy.api#documentation": "

The values of the attribute to query the quick responses by.

", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.wisdom#QuickResponseQueryOperator", + "traits": { + "smithy.api#documentation": "

The operator to use for matching attribute field values in the query.

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

Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

" + } + }, + "priority": { + "target": "com.amazonaws.wisdom#Priority", + "traits": { + "smithy.api#documentation": "

The importance of the attribute field when calculating query result relevancy scores.\n The value set for this parameter affects the ordering of search results.

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

The quick response fields to query quick responses by.

\n

The following is the list of supported field names.

\n
    \n
  • \n

    content

    \n
    • \n
  • \n

    name

    \n
    • \n
  • \n

    description

    \n
    • \n
  • \n

    shortcutKey

    \n
    • \n
" + } + }, + "com.amazonaws.wisdom#QuickResponseQueryFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#QuickResponseQueryField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.wisdom#QuickResponseQueryOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "CONTAINS_AND_PREFIX", + "name": "CONTAINS_AND_PREFIX" + } + ] + } + }, + "com.amazonaws.wisdom#QuickResponseQueryValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wisdom#QuickResponseQueryValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#QuickResponseQueryValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.wisdom#QuickResponseSearchExpression": { + "type": "structure", + "members": { + "queries": { + "target": "com.amazonaws.wisdom#QuickResponseQueryFieldList", + "traits": { + "smithy.api#documentation": "

The quick response query expressions.

" + } + }, + "filters": { + "target": "com.amazonaws.wisdom#QuickResponseFilterFieldList", + "traits": { + "smithy.api#documentation": "

The configuration of filtering rules applied to quick response query results.

" + } + }, + "orderOnField": { + "target": "com.amazonaws.wisdom#QuickResponseOrderField", + "traits": { + "smithy.api#documentation": "

The quick response attribute fields on which the query results are ordered.

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

Information about the import job.

" + } + }, + "com.amazonaws.wisdom#QuickResponseSearchResultData": { + "type": "structure", + "members": { + "quickResponseArn": { + "target": "com.amazonaws.wisdom#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick response.

", + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.wisdom#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The name of the quick response.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.wisdom#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n
    \n
  • \n

    Use application/x.quickresponse;format=plain for quick response written in plain text.

    \n
    • \n
  • \n

    Use application/x.quickresponse;format=markdown for quick response written in richtext.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.wisdom#QuickResponseStatus", + "traits": { + "smithy.api#documentation": "

The resource status of the quick response.

", + "smithy.api#required": {} + } + }, + "contents": { + "target": "com.amazonaws.wisdom#QuickResponseContents", + "traits": { + "smithy.api#documentation": "

The contents of the quick response.

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

The timestamp when the quick response was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the quick response search result data was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "isActive": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the quick response is active.

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

The description of the quick response.

" + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.wisdom#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the user groups that the quick response is accessible to.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.wisdom#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.

" + } + }, + "lastModifiedBy": { + "target": "com.amazonaws.wisdom#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

" + } + }, + "channels": { + "target": "com.amazonaws.wisdom#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + } + }, + "language": { + "target": "com.amazonaws.wisdom#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code value for the language in which the quick response is written.

" + } + }, + "attributesNotInterpolated": { + "target": "com.amazonaws.wisdom#ContactAttributeKeys", + "traits": { + "smithy.api#documentation": "

The user defined contact attributes that are not resolved when the search result is returned.

" + } + }, + "attributesInterpolated": { + "target": "com.amazonaws.wisdom#ContactAttributeKeys", + "traits": { + "smithy.api#documentation": "

The user defined contact attributes that are resolved when the search result is returned.

" + } + }, + "tags": { + "target": "com.amazonaws.wisdom#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

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

The result of quick response search.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.wisdom#QuickResponse" + }, + { + "resource": "com.amazonaws.wisdom#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.wisdom#QuickResponseSearchResultsList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#QuickResponseSearchResultData" + } + }, + "com.amazonaws.wisdom#QuickResponseStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "UPDATE_IN_PROGRESS", + "name": "UPDATE_IN_PROGRESS" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + } + ] + } + }, + "com.amazonaws.wisdom#QuickResponseSummary": { + "type": "structure", + "members": { + "quickResponseArn": { + "target": "com.amazonaws.wisdom#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick response.

", + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.wisdom#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.

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

The name of the quick response.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.wisdom#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n
    \n
  • \n

    Use application/x.quickresponse;format=plain for quick response written in plain text.

    \n
    • \n
  • \n

    Use application/x.quickresponse;format=markdown for quick response written in richtext.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.wisdom#QuickResponseStatus", + "traits": { + "smithy.api#documentation": "

The resource status of the quick response.

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

The timestamp when the quick response was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the quick response summary was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "description": { + "target": "com.amazonaws.wisdom#QuickResponseDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick response.

" + } + }, + "lastModifiedBy": { + "target": "com.amazonaws.wisdom#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.wisdom#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + } + }, + "tags": { + "target": "com.amazonaws.wisdom#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

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

The summary information about the quick response.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.wisdom#QuickResponse" + }, + { + "resource": "com.amazonaws.wisdom#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.wisdom#QuickResponseSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#QuickResponseSummary" + } + }, + "com.amazonaws.wisdom#QuickResponseType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(application/x\\.quickresponse;format=(plain|markdown))$" + } + }, + "com.amazonaws.wisdom#RecommendationData": { + "type": "structure", + "members": { + "recommendationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the recommendation.

", + "smithy.api#required": {} + } + }, + "document": { + "target": "com.amazonaws.wisdom#Document", + "traits": { + "smithy.api#documentation": "

The recommended document.

", + "smithy.api#required": {} + } + }, + "relevanceScore": { + "target": "com.amazonaws.wisdom#RelevanceScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The relevance score of the recommendation.

" + } + }, + "relevanceLevel": { + "target": "com.amazonaws.wisdom#RelevanceLevel", + "traits": { + "smithy.api#documentation": "

The relevance level of the recommendation.

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

The type of recommendation.

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

Information about the recommendation.

" + } + }, + "com.amazonaws.wisdom#RecommendationIdList": { + "type": "list", "member": { "target": "smithy.api#String" }, @@ -3219,7 +4995,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3244,6 +5020,20 @@ "smithy.api#documentation": "

Information about how to render the content.

" } }, + "com.amazonaws.wisdom#RequestTimeoutException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request reached the service more than 15 minutes after the date stamp on the request\n or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or\n the date stamp on the request is more than 15 minutes in the future.

", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#retryable": {} + } + }, "com.amazonaws.wisdom#ResourceNotFoundException": { "type": "structure", "members": { @@ -3295,15 +5085,119 @@ "com.amazonaws.wisdom#SearchContent": { "type": "operation", "input": { - "target": "com.amazonaws.wisdom#SearchContentRequest" + "target": "com.amazonaws.wisdom#SearchContentRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#SearchContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for content in a specified knowledge base. Can be used to get a specific content\n resource by its name.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/search", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "contentSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.wisdom#SearchContentRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.wisdom#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

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

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "searchExpression": { + "target": "com.amazonaws.wisdom#SearchExpression", + "traits": { + "smithy.api#documentation": "

The search expression to filter results.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wisdom#SearchContentResponse": { + "type": "structure", + "members": { + "contentSummaries": { + "target": "com.amazonaws.wisdom#ContentSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about the content.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.wisdom#SearchExpression": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.wisdom#FilterList", + "traits": { + "smithy.api#documentation": "

The search expression filters.

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

The search expression.

" + } + }, + "com.amazonaws.wisdom#SearchQuickResponses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#SearchQuickResponsesRequest" }, "output": { - "target": "com.amazonaws.wisdom#SearchContentResponse" + "target": "com.amazonaws.wisdom#SearchQuickResponsesResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, + { + "target": "com.amazonaws.wisdom#RequestTimeoutException" + }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, @@ -3312,25 +5206,39 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for content in a specified knowledge base. Can be used to get a specific content\n resource by its name.

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

Searches existing Wisdom quick responses in a Wisdom knowledge base.

", "smithy.api#http": { - "uri": "/knowledgeBases/{knowledgeBaseId}/search", + "uri": "/knowledgeBases/{knowledgeBaseId}/search/quickResponses", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "contentSummaries" - }, - "smithy.api#readonly": {} + "items": "results" + } } }, - "com.amazonaws.wisdom#SearchContentRequest": { + "com.amazonaws.wisdom#SearchQuickResponsesRequest": { "type": "structure", "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "searchExpression": { + "target": "com.amazonaws.wisdom#QuickResponseSearchExpression", + "traits": { + "smithy.api#documentation": "

The search expression for querying the quick response.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" @@ -3343,54 +5251,36 @@ "smithy.api#httpQuery": "maxResults" } }, - "knowledgeBaseId": { - "target": "com.amazonaws.wisdom#UuidOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "searchExpression": { - "target": "com.amazonaws.wisdom#SearchExpression", + "attributes": { + "target": "com.amazonaws.wisdom#ContactAttributes", "traits": { - "smithy.api#documentation": "

The search expression to filter results.

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

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.wisdom#SearchContentResponse": { + "com.amazonaws.wisdom#SearchQuickResponsesResponse": { "type": "structure", "members": { - "contentSummaries": { - "target": "com.amazonaws.wisdom#ContentSummaryList", + "results": { + "target": "com.amazonaws.wisdom#QuickResponseSearchResultsList", "traits": { - "smithy.api#documentation": "

Summary information about the content.

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

The results of the quick response search.

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

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.wisdom#SearchExpression": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.wisdom#FilterList", + "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { - "smithy.api#documentation": "

The search expression filters.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

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

The search expression.

" + "smithy.api#output": {} } }, "com.amazonaws.wisdom#SearchSessions": { @@ -3638,6 +5528,15 @@ "smithy.api#documentation": "

Summary information about the session.

" } }, + "com.amazonaws.wisdom#ShortCutKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.wisdom#SourceConfiguration": { "type": "union", "members": { @@ -3685,7 +5584,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3696,6 +5595,12 @@ "smithy.api#documentation": "

The type of content to upload.

", "smithy.api#required": {} } + }, + "presignedUrlTimeToLive": { + "target": "com.amazonaws.wisdom#TimeToLive", + "traits": { + "smithy.api#documentation": "

The expected expiration time of the generated presigned URL, specified in minutes.

" + } } } }, @@ -3733,6 +5638,103 @@ } } }, + "com.amazonaws.wisdom#StartImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#StartImportJobRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#StartImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ConflictException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to\n upload an asset that contains the resource data.

\n
    \n
  • \n

    For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

    \n
    • \n
", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.wisdom#StartImportJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

\n
    \n
  • \n

    For importing Wisdom quick responses, this should be a QUICK_RESPONSES type knowledge base.

    \n
    • \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "importJobType": { + "target": "com.amazonaws.wisdom#ImportJobType", + "traits": { + "smithy.api#documentation": "

The type of the import job.

\n
    \n
  • \n

    For importing quick response resource, set the value to QUICK_RESPONSES.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.wisdom#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.wisdom#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

", + "smithy.api#idempotencyToken": {} + } + }, + "metadata": { + "target": "com.amazonaws.wisdom#ContentMetadata", + "traits": { + "smithy.api#documentation": "

The metadata fields of the imported Wisdom resources.

" + } + }, + "externalSourceConfiguration": { + "target": "com.amazonaws.wisdom#ExternalSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the external source that the resource data are imported from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#StartImportJobResponse": { + "type": "structure", + "members": { + "importJob": { + "target": "com.amazonaws.wisdom#ImportJobData", + "traits": { + "smithy.api#documentation": "

The import job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#TagKey": { "type": "string", "traits": { @@ -3822,6 +5824,16 @@ "target": "com.amazonaws.wisdom#TagValue" } }, + "com.amazonaws.wisdom#TimeToLive": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Expiration time in minutes", + "smithy.api#range": { + "min": 1, + "max": 60 + } + } + }, "com.amazonaws.wisdom#TooManyTagsException": { "type": "structure", "members": { @@ -3924,7 +5936,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4019,7 +6031,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4044,6 +6056,149 @@ } } }, + "com.amazonaws.wisdom#UpdateQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#UpdateQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#UpdateQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ConflictException" + }, + { + "target": "com.amazonaws.wisdom#PreconditionFailedException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing Wisdom quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "method": "POST" + } + } + }, + "com.amazonaws.wisdom#UpdateQuickResponseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.wisdom#QuickResponseName", + "traits": { + "smithy.api#documentation": "

The name of the quick response.

" + } + }, + "content": { + "target": "com.amazonaws.wisdom#QuickResponseDataProvider", + "traits": { + "smithy.api#documentation": "

The updated content of the quick response.

" + } + }, + "contentType": { + "target": "com.amazonaws.wisdom#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n
    \n
  • \n

    Use application/x.quickresponse;format=plain for quick response written in plain text.

    \n
    • \n
  • \n

    Use application/x.quickresponse;format=markdown for quick response written in richtext.

    \n
    • \n
" + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.wisdom#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The updated grouping configuration of the quick response.

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

Whether to remove the grouping configuration of the quick response.

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

The updated description of the quick response.

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

Whether to remove the description from the quick response.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.wisdom#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.

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

Whether to remove the shortcut key of the quick response.

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.wisdom#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

" + } + }, + "language": { + "target": "com.amazonaws.wisdom#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wisdom#UpdateQuickResponseResponse": { + "type": "structure", + "members": { + "quickResponse": { + "target": "com.amazonaws.wisdom#QuickResponseData", + "traits": { + "smithy.api#documentation": "

The quick response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wisdom#UploadId": { "type": "string", "traits": {