From f648e7d10916fcd79f54ad1f7155cf26e464dd08 Mon Sep 17 00:00:00 2001 From: Ian Smith Botsford Date: Thu, 18 Aug 2022 20:14:15 +0000 Subject: [PATCH 1/3] chore: sync AWS models --- .../d1a26c04-4ffa-4658-9134-9b3a30a8907e.json | 5 + codegen/sdk/aws-models/amp.json | 639 +++- codegen/sdk/aws-models/app-mesh.json | 154 +- codegen/sdk/aws-models/backupstorage.json | 1376 ++++++++ .../aws-models/chime-sdk-media-pipelines.json | 1318 ++++++- .../sdk/aws-models/chime-sdk-meetings.json | 319 +- .../sdk/aws-models/chime-sdk-messaging.json | 381 +++ codegen/sdk/aws-models/cloudfront.json | 10 +- codegen/sdk/aws-models/cloudwatch.json | 262 +- .../aws-models/cognito-identity-provider.json | 20 +- codegen/sdk/aws-models/config-service.json | 36 + codegen/sdk/aws-models/connectcampaigns.json | 15 + .../database-migration-service.json | 2 +- codegen/sdk/aws-models/dlm.json | 134 +- codegen/sdk/aws-models/dynamodb.json | 704 +++- codegen/sdk/aws-models/ec2.json | 117 + codegen/sdk/aws-models/glue.json | 75 +- codegen/sdk/aws-models/identitystore.json | 68 +- codegen/sdk/aws-models/iot-wireless.json | 106 + codegen/sdk/aws-models/iot.json | 157 +- codegen/sdk/aws-models/ivs.json | 188 +- codegen/sdk/aws-models/kendra.json | 70 +- codegen/sdk/aws-models/lakeformation.json | 118 +- codegen/sdk/aws-models/lambda.json | 78 +- codegen/sdk/aws-models/lex-models-v2.json | 643 +++- codegen/sdk/aws-models/location.json | 57 +- codegen/sdk/aws-models/networkmanager.json | 16 + .../sdk/aws-models/personalize-runtime.json | 77 +- codegen/sdk/aws-models/pinpoint.json | 232 ++ codegen/sdk/aws-models/privatenetworks.json | 3040 +++++++++++++++++ codegen/sdk/aws-models/quicksight.json | 16 +- codegen/sdk/aws-models/rds.json | 50 +- codegen/sdk/aws-models/rekognition.json | 506 ++- .../sdk/aws-models/sagemaker-a2i-runtime.json | 42 +- codegen/sdk/aws-models/sagemaker.json | 343 +- codegen/sdk/aws-models/secrets-manager.json | 20 +- codegen/sdk/aws-models/service-catalog.json | 108 +- codegen/sdk/aws-models/sso-admin.json | 162 +- codegen/sdk/aws-models/sso-oidc.json | 74 +- codegen/sdk/aws-models/sso.json | 81 +- codegen/sdk/aws-models/wisdom.json | 151 + 41 files changed, 11098 insertions(+), 872 deletions(-) create mode 100644 .changes/d1a26c04-4ffa-4658-9134-9b3a30a8907e.json create mode 100644 codegen/sdk/aws-models/backupstorage.json create mode 100644 codegen/sdk/aws-models/privatenetworks.json diff --git a/.changes/d1a26c04-4ffa-4658-9134-9b3a30a8907e.json b/.changes/d1a26c04-4ffa-4658-9134-9b3a30a8907e.json new file mode 100644 index 00000000000..b1ae87e4797 --- /dev/null +++ b/.changes/d1a26c04-4ffa-4658-9134-9b3a30a8907e.json @@ -0,0 +1,5 @@ +{ + "id": "d1a26c04-4ffa-4658-9134-9b3a30a8907e", + "type": "misc", + "description": "Sync AWS service models" +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/amp.json b/codegen/sdk/aws-models/amp.json index 9f97ba92d18..929f4c440ea 100644 --- a/codegen/sdk/aws-models/amp.json +++ b/codegen/sdk/aws-models/amp.json @@ -39,10 +39,7 @@ }, "traits": { "aws.api#arn": { - "template": "workspace/{workspaceId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "workspace/{workspaceId}" }, "smithy.api#documentation": "The definition of the alert manager in the AMP workspace" } @@ -116,33 +113,33 @@ "smithy.api#documentation": "State of an alert manager definition.", "smithy.api#enum": [ { - "value": "CREATING", "name": "CREATING", + "value": "CREATING", "documentation": "Definition is being created. Update/Deletion is disallowed until definition is ACTIVE and workspace status is ACTIVE." }, { - "value": "ACTIVE", "name": "ACTIVE", + "value": "ACTIVE", "documentation": "Definition has been created/updated. Update/Deletion is disallowed until definition is ACTIVE and workspace status is ACTIVE." }, { - "value": "UPDATING", "name": "UPDATING", + "value": "UPDATING", "documentation": "Definition is being updated. Update/Deletion is disallowed until definition is ACTIVE and workspace status is ACTIVE." }, { - "value": "DELETING", "name": "DELETING", + "value": "DELETING", "documentation": "Definition is being deleting. Update/Deletion is disallowed until definition is ACTIVE and workspace status is ACTIVE." }, { - "value": "CREATION_FAILED", "name": "CREATION_FAILED", + "value": "CREATION_FAILED", "documentation": "Definition creation failed." }, { - "value": "UPDATE_FAILED", "name": "UPDATE_FAILED", + "value": "UPDATE_FAILED", "documentation": "Definition update failed." } ] @@ -150,30 +147,11 @@ }, "com.amazonaws.amp#AmazonPrometheusService": { "type": "service", - "version": "2020-08-01", - "operations": [ - { - "target": "com.amazonaws.amp#ListTagsForResource" - }, - { - "target": "com.amazonaws.amp#TagResource" - }, - { - "target": "com.amazonaws.amp#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.amp#Workspace" - } - ], "traits": { "aws.api#service": { "sdkId": "amp", "arnNamespace": "aps", - "cloudFormationName": "AmazonPrometheusService", - "cloudTrailEventSource": "CLOUDTRAIL_PLACEHOLDER_REPLACED_BY_CDK", - "endpointPrefix": "aps" + "cloudTrailEventSource": "CLOUDTRAIL_PLACEHOLDER_REPLACED_BY_CDK" }, "aws.auth#sigv4": { "name": "aps" @@ -181,30 +159,47 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ + "*", "Authorization", - "x-amz-content-sha256", + "Date", "X-Amz-Date", - "x-amzn-trace-id", - "X-Amz-Security-Token", - "x-amz-user-agent", - "*", "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", "x-amzn-platform-id", - "X-Amz-Target", - "Date" + "x-amzn-trace-id", + "X-Amz-Security-Token", + "X-Amz-Target" ], "additionalExposedHeaders": [ - "date", - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", "x-amzn-requestid", - "x-amzn-errormessage" + "x-amzn-trace-id", + "x-amzn-errormessage", + "x-amz-apigw-id", + "date" ] }, "smithy.api#documentation": "Amazon Managed Service for Prometheus", "smithy.api#title": "Amazon Prometheus Service" - } + }, + "version": "2020-08-01", + "operations": [ + { + "target": "com.amazonaws.amp#ListTagsForResource" + }, + { + "target": "com.amazonaws.amp#TagResource" + }, + { + "target": "com.amazonaws.amp#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.amp#Workspace" + } + ] }, "com.amazonaws.amp#ConflictException": { "type": "structure", @@ -271,9 +266,9 @@ "traits": { "smithy.api#documentation": "Create an alert manager definition.", "smithy.api#http": { + "code": 202, "method": "POST", - "uri": "/workspaces/{workspaceId}/alertmanager/definition", - "code": 202 + "uri": "/workspaces/{workspaceId}/alertmanager/definition" }, "smithy.api#idempotent": {} } @@ -323,6 +318,83 @@ "smithy.api#documentation": "Represents the output of a CreateAlertManagerDefinition operation." } }, + "com.amazonaws.amp#CreateLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#CreateLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.amp#CreateLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create logging configuration.", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/workspaces/{workspaceId}/logging" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#CreateLoggingConfigurationRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "logGroupArn": { + "target": "com.amazonaws.amp#LogGroupArn", + "traits": { + "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.amp#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a CreateLoggingConfiguration operation." + } + }, + "com.amazonaws.amp#CreateLoggingConfigurationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#LoggingConfigurationStatus", + "traits": { + "smithy.api#documentation": "The status of the logging configuration.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the output of a CreateLoggingConfiguration operation." + } + }, "com.amazonaws.amp#CreateRuleGroupsNamespace": { "type": "operation", "input": { @@ -357,9 +429,9 @@ "traits": { "smithy.api#documentation": "Create a rule group namespace.", "smithy.api#http": { + "code": 202, "method": "POST", - "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces", - "code": 202 + "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces" }, "smithy.api#idempotent": {} } @@ -473,9 +545,9 @@ "traits": { "smithy.api#documentation": "Creates a new AMP workspace.", "smithy.api#http": { + "code": 202, "method": "POST", - "uri": "/workspaces", - "code": 202 + "uri": "/workspaces" }, "smithy.api#idempotent": {} } @@ -547,6 +619,9 @@ "input": { "target": "com.amazonaws.amp#DeleteAlertManagerDefinitionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.amp#AccessDeniedException" @@ -570,9 +645,9 @@ "traits": { "smithy.api#documentation": "Deletes an alert manager definition.", "smithy.api#http": { + "code": 202, "method": "DELETE", - "uri": "/workspaces/{workspaceId}/alertmanager/definition", - "code": 202 + "uri": "/workspaces/{workspaceId}/alertmanager/definition" }, "smithy.api#idempotent": {} } @@ -601,11 +676,73 @@ "smithy.api#documentation": "Represents the input of a DeleteAlertManagerDefinition operation." } }, + "com.amazonaws.amp#DeleteLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#DeleteLoggingConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#ConflictException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete logging configuration.", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/workspaces/{workspaceId}/logging" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#DeleteLoggingConfigurationRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.amp#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a DeleteLoggingConfiguration operation." + } + }, "com.amazonaws.amp#DeleteRuleGroupsNamespace": { "type": "operation", "input": { "target": "com.amazonaws.amp#DeleteRuleGroupsNamespaceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.amp#AccessDeniedException" @@ -629,9 +766,9 @@ "traits": { "smithy.api#documentation": "Delete a rule groups namespace.", "smithy.api#http": { + "code": 202, "method": "DELETE", - "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", - "code": 202 + "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}" }, "smithy.api#idempotent": {} } @@ -673,6 +810,9 @@ "input": { "target": "com.amazonaws.amp#DeleteWorkspaceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.amp#AccessDeniedException" @@ -696,9 +836,9 @@ "traits": { "smithy.api#documentation": "Deletes an AMP workspace.", "smithy.api#http": { + "code": 202, "method": "DELETE", - "uri": "/workspaces/{workspaceId}", - "code": 202 + "uri": "/workspaces/{workspaceId}" }, "smithy.api#idempotent": {} } @@ -755,9 +895,9 @@ "traits": { "smithy.api#documentation": "Describes an alert manager definition.", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces/{workspaceId}/alertmanager/definition", - "code": 200 + "uri": "/workspaces/{workspaceId}/alertmanager/definition" }, "smithy.api#readonly": {} } @@ -793,6 +933,69 @@ "smithy.api#documentation": "Represents the output of a DescribeAlertManagerDefinition operation." } }, + "com.amazonaws.amp#DescribeLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#DescribeLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.amp#DescribeLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes logging configuration.", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/workspaces/{workspaceId}/logging" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amp#DescribeLoggingConfigurationRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a DescribeLoggingConfiguration operation." + } + }, + "com.amazonaws.amp#DescribeLoggingConfigurationResponse": { + "type": "structure", + "members": { + "loggingConfiguration": { + "target": "com.amazonaws.amp#LoggingConfigurationMetadata", + "traits": { + "smithy.api#documentation": "Metadata object containing information about the logging configuration of a workspace.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the output of a DescribeLoggingConfiguration operation." + } + }, "com.amazonaws.amp#DescribeRuleGroupsNamespace": { "type": "operation", "input": { @@ -821,9 +1024,9 @@ "traits": { "smithy.api#documentation": "Describe a rule groups namespace.", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", - "code": 200 + "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}" }, "smithy.api#readonly": {} } @@ -895,9 +1098,9 @@ "traits": { "smithy.api#documentation": "Describes an existing AMP workspace.", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces/{workspaceId}", - "code": 200 + "uri": "/workspaces/{workspaceId}" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { @@ -1055,15 +1258,15 @@ "traits": { "smithy.api#documentation": "Lists rule groups namespaces.", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces", - "code": 200 + "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "ruleGroupsNamespaces", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "ruleGroupsNamespaces" }, "smithy.api#readonly": {} } @@ -1159,8 +1362,7 @@ "smithy.api#documentation": "Lists the tags you have assigned to the resource.", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -1211,15 +1413,15 @@ "traits": { "smithy.api#documentation": "Lists all AMP workspaces, including workspaces being created or deleted.", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces", - "code": 200 + "uri": "/workspaces" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "workspaces", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "workspaces" }, "smithy.api#readonly": {} } @@ -1278,6 +1480,143 @@ "smithy.api#documentation": "Represents the output of a ListWorkspaces operation." } }, + "com.amazonaws.amp#LogGroupArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::Logs::LogGroup" + }, + "smithy.api#pattern": "^arn:aws[a-z0-9-]*:logs:[a-z0-9-]+:\\d{12}:log-group:[A-Za-z0-9\\.\\-\\_\\#/]{1,512}\\:\\*$" + } + }, + "com.amazonaws.amp#LoggingConfiguration": { + "type": "resource", + "identifiers": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId" + } + }, + "put": { + "target": "com.amazonaws.amp#CreateLoggingConfiguration" + }, + "read": { + "target": "com.amazonaws.amp#DescribeLoggingConfiguration" + }, + "update": { + "target": "com.amazonaws.amp#UpdateLoggingConfiguration" + }, + "delete": { + "target": "com.amazonaws.amp#DeleteLoggingConfiguration" + }, + "traits": { + "aws.api#arn": { + "template": "workspace/{workspaceId}" + }, + "smithy.api#documentation": "The definition of logging configuration in an AMP workspace." + } + }, + "com.amazonaws.amp#LoggingConfigurationMetadata": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#LoggingConfigurationStatus", + "traits": { + "smithy.api#documentation": "The status of the logging configuration.", + "smithy.api#required": {} + } + }, + "workspace": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "The workspace where the logging configuration exists.", + "smithy.api#required": {} + } + }, + "logGroupArn": { + "target": "com.amazonaws.amp#LogGroupArn", + "traits": { + "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the logging configuration was created.", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the logging configuration was modified.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the properties of a logging configuration metadata." + } + }, + "com.amazonaws.amp#LoggingConfigurationStatus": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.amp#LoggingConfigurationStatusCode", + "traits": { + "smithy.api#documentation": "Status code of the logging configuration.", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if any." + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the status of a logging configuration." + } + }, + "com.amazonaws.amp#LoggingConfigurationStatusCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "State of a logging configuration.", + "smithy.api#enum": [ + { + "name": "CREATING", + "value": "CREATING", + "documentation": "Logging configuration is being created. Update/Deletion is disallowed until logging configuration is ACTIVE and workspace status is ACTIVE." + }, + { + "name": "ACTIVE", + "value": "ACTIVE", + "documentation": "Logging configuration has been created/updated. Update/Deletion is disallowed until logging configuration is ACTIVE and workspace status is ACTIVE." + }, + { + "name": "UPDATING", + "value": "UPDATING", + "documentation": "Logging configuration is being updated. Update/Deletion is disallowed until logging configuration is ACTIVE and workspace status is ACTIVE." + }, + { + "name": "DELETING", + "value": "DELETING", + "documentation": "Logging configuration is being deleting. Update/Deletion is disallowed until logging configuration is ACTIVE and workspace status is ACTIVE." + }, + { + "name": "CREATION_FAILED", + "value": "CREATION_FAILED", + "documentation": "Logging configuration creation failed." + }, + { + "name": "UPDATE_FAILED", + "value": "UPDATE_FAILED", + "documentation": "Logging configuration update failed." + } + ] + } + }, "com.amazonaws.amp#PaginationToken": { "type": "string", "traits": { @@ -1318,9 +1657,9 @@ "traits": { "smithy.api#documentation": "Update an alert manager definition.", "smithy.api#http": { + "code": 202, "method": "PUT", - "uri": "/workspaces/{workspaceId}/alertmanager/definition", - "code": 202 + "uri": "/workspaces/{workspaceId}/alertmanager/definition" }, "smithy.api#idempotent": {} } @@ -1404,9 +1743,9 @@ "traits": { "smithy.api#documentation": "Update a rule groups namespace.", "smithy.api#http": { + "code": 202, "method": "PUT", - "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", - "code": 202 + "uri": "/workspaces/{workspaceId}/rulegroupsnamespaces/{name}" }, "smithy.api#idempotent": {} } @@ -1542,10 +1881,7 @@ }, "traits": { "aws.api#arn": { - "template": "rulegroupsnamespace/{workspaceId}/{name}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "rulegroupsnamespace/{workspaceId}/{name}" }, "smithy.api#documentation": "The definition of a rule group namespace in an AMP workspace" } @@ -1555,8 +1891,8 @@ "traits": { "aws.api#arnReference": { "type": "AWS::APS::RuleGroupsNamespace", - "service": "com.amazonaws.services.awsprometheus.serviceapi#ManagedPrometheusCP", - "resource": "com.amazonaws.amp#RuleGroupsNamespace" + "service": "ManagedPrometheusCP", + "resource": "RuleGroupsNamespace" }, "smithy.api#documentation": "An ARN identifying a rule groups namespace." } @@ -1661,33 +1997,33 @@ "smithy.api#documentation": "State of a namespace.", "smithy.api#enum": [ { - "value": "CREATING", "name": "CREATING", + "value": "CREATING", "documentation": "Namespace is being created. Update/Deletion is disallowed until namespace is ACTIVE and workspace status is ACTIVE." }, { - "value": "ACTIVE", "name": "ACTIVE", + "value": "ACTIVE", "documentation": "Namespace has been created/updated. Update/Deletion is disallowed until namespace is ACTIVE and workspace status is ACTIVE." }, { - "value": "UPDATING", "name": "UPDATING", + "value": "UPDATING", "documentation": "Namespace is being updated. Update/Deletion is disallowed until namespace is ACTIVE and workspace status is ACTIVE." }, { - "value": "DELETING", "name": "DELETING", + "value": "DELETING", "documentation": "Namespace is being deleting. Update/Deletion is disallowed until namespace is ACTIVE and workspace status is ACTIVE." }, { - "value": "CREATION_FAILED", "name": "CREATION_FAILED", + "value": "CREATION_FAILED", "documentation": "Namespace creation failed." }, { - "value": "UPDATE_FAILED", "name": "UPDATE_FAILED", + "value": "UPDATE_FAILED", "documentation": "Namespace update failed." } ] @@ -1862,8 +2198,7 @@ "smithy.api#documentation": "Creates tags for the specified resource.", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" } } }, @@ -1966,8 +2301,7 @@ "smithy.api#documentation": "Deletes tags from the specified resource.", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -1997,11 +2331,94 @@ "type": "structure", "members": {} }, + "com.amazonaws.amp#UpdateLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#UpdateLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.amp#UpdateLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#ConflictException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update logging configuration.", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/workspaces/{workspaceId}/logging" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#UpdateLoggingConfigurationRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "logGroupArn": { + "target": "com.amazonaws.amp#LogGroupArn", + "traits": { + "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.amp#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of an UpdateLoggingConfiguration operation." + } + }, + "com.amazonaws.amp#UpdateLoggingConfigurationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#LoggingConfigurationStatus", + "traits": { + "smithy.api#documentation": "The status of the logging configuration.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the output of an UpdateLoggingConfiguration operation." + } + }, "com.amazonaws.amp#UpdateWorkspaceAlias": { "type": "operation", "input": { "target": "com.amazonaws.amp#UpdateWorkspaceAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.amp#AccessDeniedException" @@ -2028,9 +2445,9 @@ "traits": { "smithy.api#documentation": "Updates an AMP workspace alias.", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/workspaces/{workspaceId}/alias", - "code": 204 + "uri": "/workspaces/{workspaceId}/alias" }, "smithy.api#idempotent": {} } @@ -2140,20 +2557,20 @@ "smithy.api#documentation": "Possible reasons a request failed validation.", "smithy.api#enum": [ { - "value": "UNKNOWN_OPERATION", - "name": "UNKNOWN_OPERATION" + "name": "UNKNOWN_OPERATION", + "value": "UNKNOWN_OPERATION" }, { - "value": "CANNOT_PARSE", - "name": "CANNOT_PARSE" + "name": "CANNOT_PARSE", + "value": "CANNOT_PARSE" }, { - "value": "FIELD_VALIDATION_FAILED", - "name": "FIELD_VALIDATION_FAILED" + "name": "FIELD_VALIDATION_FAILED", + "value": "FIELD_VALIDATION_FAILED" }, { - "value": "OTHER", - "name": "OTHER" + "name": "OTHER", + "value": "OTHER" } ] } @@ -2184,16 +2601,16 @@ { "target": "com.amazonaws.amp#AlertManagerDefinition" }, + { + "target": "com.amazonaws.amp#LoggingConfiguration" + }, { "target": "com.amazonaws.amp#RuleGroupsNamespace" } ], "traits": { "aws.api#arn": { - "template": "workspace/{workspaceId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "workspace/{workspaceId}" }, "smithy.api#documentation": "An AMP workspace is a logical and isolated Prometheus server dedicated to Prometheus resources such as metrics, where you ingest, store, and query your Prometheus metrics." } @@ -2213,8 +2630,8 @@ "traits": { "aws.api#arnReference": { "type": "AWS::APS::Workspace", - "service": "com.amazonaws.services.awsprometheus.serviceapi#ManagedPrometheusCP", - "resource": "com.amazonaws.amp#Workspace" + "service": "ManagedPrometheusCP", + "resource": "Workspace" }, "smithy.api#documentation": "An ARN identifying a Workspace." } @@ -2310,28 +2727,28 @@ "smithy.api#documentation": "State of a workspace.", "smithy.api#enum": [ { - "value": "CREATING", "name": "CREATING", + "value": "CREATING", "documentation": "Workspace is being created. Deletion is disallowed until status is ACTIVE." }, { - "value": "ACTIVE", "name": "ACTIVE", + "value": "ACTIVE", "documentation": "Workspace has been created and is usable." }, { - "value": "UPDATING", "name": "UPDATING", + "value": "UPDATING", "documentation": "Workspace is being updated. Updates are allowed only when status is ACTIVE." }, { - "value": "DELETING", "name": "DELETING", + "value": "DELETING", "documentation": "Workspace is being deleted. Deletions are allowed only when status is ACTIVE." }, { - "value": "CREATION_FAILED", "name": "CREATION_FAILED", + "value": "CREATION_FAILED", "documentation": "Workspace creation failed. Refer to WorkspaceStatus.failureReason for more details." } ] diff --git a/codegen/sdk/aws-models/app-mesh.json b/codegen/sdk/aws-models/app-mesh.json index ec75109b23b..a0ea0999c0e 100644 --- a/codegen/sdk/aws-models/app-mesh.json +++ b/codegen/sdk/aws-models/app-mesh.json @@ -146,7 +146,7 @@ "ipPreference": { "target": "com.amazonaws.appmesh#IpPreference", "traits": { - "smithy.api#documentation": "

The IP version to use to control traffic within the mesh.

" + "smithy.api#documentation": "

The preferred IP version that this virtual node uses. Setting the IP preference on the\n virtual node only overrides the IP preference set for the mesh on this specific\n node.

" } } }, @@ -2312,7 +2312,7 @@ "ipPreference": { "target": "com.amazonaws.appmesh#IpPreference", "traits": { - "smithy.api#documentation": "

The IP version to use to control traffic within the mesh.

" + "smithy.api#documentation": "

The preferred IP version that this virtual node uses. Setting the IP preference on the\n virtual node only overrides the IP preference set for the mesh on this specific\n node.

" } } }, @@ -2412,6 +2412,12 @@ "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#required": {} } + }, + "format": { + "target": "com.amazonaws.appmesh#LoggingFormat", + "traits": { + "smithy.api#documentation": "

The specified format for the logs. The format is either json_format or\n text_format.

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

An object that represents a virtual service gateway route target.

", "smithy.api#required": {} } + }, + "port": { + "target": "com.amazonaws.appmesh#ListenerPort", + "traits": { + "smithy.api#documentation": "

The port number of the gateway route target.

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

The gateway route metadata to be matched on.

" } + }, + "port": { + "target": "com.amazonaws.appmesh#ListenerPort", + "traits": { + "smithy.api#documentation": "

The port number to match from the request.

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

An object that represents the data to match from the request.

" } + }, + "port": { + "target": "com.amazonaws.appmesh#ListenerPort", + "traits": { + "smithy.api#documentation": "

The port number to match on.

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

The client request headers to match on.

" } + }, + "port": { + "target": "com.amazonaws.appmesh#ListenerPort", + "traits": { + "smithy.api#documentation": "

The port number to match on.

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

The client request headers to match on.

" } + }, + "port": { + "target": "com.amazonaws.appmesh#ListenerPort", + "traits": { + "smithy.api#documentation": "

The port number to match on.

" + } } }, "traits": { @@ -3867,6 +3903,52 @@ ] } }, + "com.amazonaws.appmesh#JsonFormat": { + "type": "list", + "member": { + "target": "com.amazonaws.appmesh#JsonFormatRef" + } + }, + "com.amazonaws.appmesh#JsonFormatRef": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.appmesh#JsonKey", + "traits": { + "smithy.api#documentation": "

The specified key for the JSON.

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

The specified value for the JSON.

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

An object that represents the key value pairs for the JSON.

" + } + }, + "com.amazonaws.appmesh#JsonKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.appmesh#JsonValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.appmesh#LimitExceededException": { "type": "structure", "members": { @@ -4796,7 +4878,7 @@ "smithy.api#documentation": "

An object that represents a listener for a virtual node.

" } }, - "com.amazonaws.lattice.v20190125#ListenerPort": { + "com.amazonaws.appmesh#ListenerPort": { "type": "integer", "traits": { "smithy.api#box": {}, @@ -5024,6 +5106,26 @@ "smithy.api#documentation": "

An object that represents the logging information for a virtual node.

" } }, + "com.amazonaws.appmesh#LoggingFormat": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.appmesh#TextFormat", + "traits": { + "smithy.api#documentation": "

" + } + }, + "json": { + "target": "com.amazonaws.appmesh#JsonFormat", + "traits": { + "smithy.api#documentation": "

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

An object that represents the format for the logs.

" + } + }, "com.amazonaws.appmesh#MatchRange": { "type": "structure", "members": { @@ -5436,7 +5538,8 @@ "type": "set", "member": { "target": "com.amazonaws.appmesh#PortNumber" - } + }, + "traits": {} }, "com.amazonaws.appmesh#QueryParameterMatch": { "type": "structure", @@ -6065,6 +6168,12 @@ "traits": { "smithy.api#documentation": "

An object that represents types of timeouts.

" } + }, + "match": { + "target": "com.amazonaws.appmesh#TcpRouteMatch", + "traits": { + "smithy.api#documentation": "

An object that represents the criteria for determining a request match.

" + } } }, "traits": { @@ -6086,6 +6195,20 @@ "smithy.api#documentation": "

An object that represents the action to take if a match is determined.

" } }, + "com.amazonaws.appmesh#TcpRouteMatch": { + "type": "structure", + "members": { + "port": { + "target": "com.amazonaws.appmesh#ListenerPort", + "traits": { + "smithy.api#documentation": "

The port number to match on.

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

An object representing the TCP route to match.

" + } + }, "com.amazonaws.appmesh#TcpTimeout": { "type": "structure", "members": { @@ -6100,6 +6223,15 @@ "smithy.api#documentation": "

An object that represents types of timeouts.

" } }, + "com.amazonaws.appmesh#TextFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.appmesh#TlsValidationContext": { "type": "structure", "members": { @@ -6113,7 +6245,7 @@ "subjectAlternativeNames": { "target": "com.amazonaws.appmesh#SubjectAlternativeNames", "traits": { - "smithy.api#documentation": "

A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

" + "smithy.api#documentation": "

A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you\n don't specify SANs on the terminating mesh endpoint, the Envoy proxy\n for that node doesn't verify the SAN on a peer client certificate. If you don't specify\n SANs on the originating mesh endpoint, the SAN on the certificate\n provided by the terminating endpoint must match the mesh endpoint service discovery\n configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the\n SAN since the name doesn't match the service discovery name.

" } } }, @@ -7240,6 +7372,12 @@ "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.

", "smithy.api#required": {} } + }, + "format": { + "target": "com.amazonaws.appmesh#LoggingFormat", + "traits": { + "smithy.api#documentation": "

The specified format for the virtual gateway access logs. It can be either\n json_format or text_format.

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

The relative weight of the weighted target.

", "smithy.api#required": {} } + }, + "port": { + "target": "com.amazonaws.appmesh#ListenerPort", + "traits": { + "smithy.api#documentation": "

The targeted port of the weighted object.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/backupstorage.json b/codegen/sdk/aws-models/backupstorage.json new file mode 100644 index 00000000000..d6396719347 --- /dev/null +++ b/codegen/sdk/aws-models/backupstorage.json @@ -0,0 +1,1376 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.backupstorage#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#ServiceErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.backupstorage#BackupObject": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object name", + "smithy.api#required": {} + } + }, + "ChunksCount": { + "target": "com.amazonaws.backupstorage#OptionalLong", + "traits": { + "smithy.api#documentation": "Number of chunks in object" + } + }, + "MetadataString": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Metadata string associated with the Object" + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + }, + "ObjectToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object token", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Object" + } + }, + "com.amazonaws.backupstorage#Chunk": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Chunk index", + "smithy.api#required": {} + } + }, + "Length": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Chunk length", + "smithy.api#required": {} + } + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk checksum", + "smithy.api#required": {} + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + }, + "ChunkToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk token", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Chunk" + } + }, + "com.amazonaws.backupstorage#ChunkList": { + "type": "list", + "member": { + "target": "com.amazonaws.backupstorage#Chunk" + } + }, + "com.amazonaws.backupstorage#CryoStorageFrontendService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "BackupStorage", + "arnNamespace": "backup-storage", + "cloudFormationName": "BackupStorage", + "cloudTrailEventSource": "backupstorage.amazonaws.com", + "endpointPrefix": "backupstorage" + }, + "aws.auth#sigv4": { + "name": "backup-storage" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "The frontend service for Cryo Storage.", + "smithy.api#title": "AWS Backup Storage" + }, + "version": "2018-04-10", + "operations": [ + { + "target": "com.amazonaws.backupstorage#DeleteObject" + }, + { + "target": "com.amazonaws.backupstorage#GetChunk" + }, + { + "target": "com.amazonaws.backupstorage#GetObjectMetadata" + }, + { + "target": "com.amazonaws.backupstorage#ListChunks" + }, + { + "target": "com.amazonaws.backupstorage#ListObjects" + }, + { + "target": "com.amazonaws.backupstorage#NotifyObjectComplete" + }, + { + "target": "com.amazonaws.backupstorage#PutChunk" + }, + { + "target": "com.amazonaws.backupstorage#PutObject" + }, + { + "target": "com.amazonaws.backupstorage#StartObject" + } + ] + }, + "com.amazonaws.backupstorage#DataAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Data checksum used" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Checksum algorithm used" + } + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception. Attempted to create already existing object or chunk.\n This message contains a checksum of already presented data.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#DataChecksumAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHA256", + "name": "SHA256" + } + ] + } + }, + "com.amazonaws.backupstorage#DeleteObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#DeleteObjectInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Delete Object from the incremental base Backup.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/backup-jobs/{BackupJobId}/object/{ObjectName}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#DeleteObjectInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "The name of the Object.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetChunk": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#GetChunkInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#GetChunkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the specified object's chunk.", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/chunk/{ChunkToken}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#GetChunkInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Storage job id", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChunkToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk token", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetChunkOutput": { + "type": "structure", + "members": { + "Data": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Chunk data", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "Length": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Data length", + "smithy.api#httpHeader": "x-amz-data-length", + "smithy.api#required": {} + } + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Data checksum", + "smithy.api#httpHeader": "x-amz-checksum", + "smithy.api#required": {} + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#httpHeader": "x-amz-checksum-algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetObjectMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#GetObjectMetadataInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#GetObjectMetadataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get metadata associated with an Object.", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/object/{ObjectToken}/metadata", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#GetObjectMetadataInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object token.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetObjectMetadataOutput": { + "type": "structure", + "members": { + "MetadataString": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Metadata string.", + "smithy.api#httpHeader": "x-amz-metadata-string" + } + }, + "MetadataBlob": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Metadata blob.", + "smithy.api#httpPayload": {} + } + }, + "MetadataBlobLength": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "The size of MetadataBlob.", + "smithy.api#httpHeader": "x-amz-data-length" + } + }, + "MetadataBlobChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "MetadataBlob checksum.", + "smithy.api#httpHeader": "x-amz-checksum" + } + }, + "MetadataBlobChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm.", + "smithy.api#httpHeader": "x-amz-checksum-algorithm" + } + } + } + }, + "com.amazonaws.backupstorage#IllegalArgumentException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception, indicates client error (wrong argument passed to API).\n See exception message for details.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#KMSInvalidKeyUsageException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#ListChunks": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#ListChunksInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#ListChunksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "List chunks in a given Object", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/chunks/{ObjectToken}/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backupstorage#ListChunksInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Storage job id", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object token", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.backupstorage#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of chunks", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.backupstorage#ListChunksOutput": { + "type": "structure", + "members": { + "ChunkList": { + "target": "com.amazonaws.backupstorage#ChunkList", + "traits": { + "smithy.api#documentation": "List of chunks", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token" + } + } + } + }, + "com.amazonaws.backupstorage#ListObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#ListObjectsInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#ListObjectsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "List all Objects in a given Backup.", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/objects/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backupstorage#ListObjectsInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Storage job id", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartingObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL", + "smithy.api#httpQuery": "starting-object-name" + } + }, + "StartingObjectPrefix": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL", + "smithy.api#httpQuery": "starting-object-prefix" + } + }, + "MaxResults": { + "target": "com.amazonaws.backupstorage#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum objects count", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token", + "smithy.api#httpQuery": "next-token" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.backupstorage#timestamp", + "traits": { + "smithy.api#documentation": "(Optional) Created before filter", + "smithy.api#httpQuery": "created-before" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.backupstorage#timestamp", + "traits": { + "smithy.api#documentation": "(Optional) Created after filter", + "smithy.api#httpQuery": "created-after" + } + } + } + }, + "com.amazonaws.backupstorage#ListObjectsOutput": { + "type": "structure", + "members": { + "ObjectList": { + "target": "com.amazonaws.backupstorage#ObjectList", + "traits": { + "smithy.api#documentation": "Object list", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token" + } + } + } + }, + "com.amazonaws.backupstorage#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.backupstorage#MetadataString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^.{1,256}$" + } + }, + "com.amazonaws.backupstorage#NotReadableInputStreamException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#NotifyObjectComplete": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#NotifyObjectCompleteInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#NotifyObjectCompleteOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#NotReadableInputStreamException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "aws.auth#unsignedPayload": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "Complete upload", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/object/{UploadId}/complete", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#NotifyObjectCompleteInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Upload Id for the in-progress upload", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object checksum", + "smithy.api#httpQuery": "checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#httpQuery": "checksum-algorithm", + "smithy.api#required": {} + } + }, + "MetadataString": { + "target": "com.amazonaws.backupstorage#MetadataString", + "traits": { + "smithy.api#documentation": "Optional metadata associated with an Object. Maximum string length is 256 bytes.", + "smithy.api#httpQuery": "metadata-string" + } + }, + "MetadataBlob": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Optional metadata associated with an Object. Maximum length is 4MB.", + "smithy.api#httpPayload": {} + } + }, + "MetadataBlobLength": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "The size of MetadataBlob.", + "smithy.api#httpQuery": "metadata-blob-length" + } + }, + "MetadataBlobChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Checksum of MetadataBlob.", + "smithy.api#httpQuery": "metadata-checksum" + } + }, + "MetadataBlobChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm.", + "smithy.api#httpQuery": "metadata-checksum-algorithm" + } + } + } + }, + "com.amazonaws.backupstorage#NotifyObjectCompleteOutput": { + "type": "structure", + "members": { + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#ObjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.backupstorage#BackupObject" + } + }, + "com.amazonaws.backupstorage#OptionalLong": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.backupstorage#PayloadBlob": { + "type": "blob", + "traits": { + "smithy.api#streaming": {} + } + }, + "com.amazonaws.backupstorage#PutChunk": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#PutChunkInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#PutChunkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#NotReadableInputStreamException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "aws.auth#unsignedPayload": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "Upload chunk.", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/chunk/{UploadId}/{ChunkIndex}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#PutChunkInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Upload Id for the in-progress upload.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChunkIndex": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Describes this chunk's position relative to the other chunks", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Data": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Data to be uploaded", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "Length": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Data length", + "smithy.api#httpQuery": "length", + "smithy.api#required": {} + } + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Data checksum", + "smithy.api#httpQuery": "checksum", + "smithy.api#required": {} + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#httpQuery": "checksum-algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#PutChunkOutput": { + "type": "structure", + "members": { + "ChunkChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk checksum", + "smithy.api#required": {} + } + }, + "ChunkChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#PutObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#PutObjectInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#PutObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#NotReadableInputStreamException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "aws.auth#unsignedPayload": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "Upload object that can store object metadata String and data blob in single API call using inline chunk field.", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/object/{ObjectName}/put-object", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#PutObjectInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "The name of the Object to be uploaded.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MetadataString": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Store user defined metadata like backup checksum, disk ids, restore metadata etc.", + "smithy.api#httpQuery": "metadata-string" + } + }, + "InlineChunk": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Inline chunk data to be uploaded.", + "smithy.api#httpPayload": {} + } + }, + "InlineChunkLength": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Length of the inline chunk data.", + "smithy.api#httpQuery": "length" + } + }, + "InlineChunkChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Inline chunk checksum", + "smithy.api#httpQuery": "checksum" + } + }, + "InlineChunkChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Inline chunk checksum algorithm", + "smithy.api#httpQuery": "checksum-algorithm" + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "object checksum", + "smithy.api#httpQuery": "object-checksum" + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "object checksum algorithm", + "smithy.api#httpQuery": "object-checksum-algorithm" + } + }, + "ThrowOnDuplicate": { + "target": "com.amazonaws.backupstorage#boolean", + "traits": { + "smithy.api#documentation": "Throw an exception if Object name is already exist.", + "smithy.api#httpQuery": "throwOnDuplicate" + } + } + } + }, + "com.amazonaws.backupstorage#PutObjectOutput": { + "type": "structure", + "members": { + "InlineChunkChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Inline chunk checksum", + "smithy.api#required": {} + } + }, + "InlineChunkChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Inline chunk checksum algorithm", + "smithy.api#required": {} + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "object checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "object checksum algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception. Attempted to make an operation on non-existing or expired resource.", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.backupstorage#RetryableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Retryable exception. In general indicates internal failure that can be fixed by retry.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.backupstorage#ServiceErrorMessage": { + "type": "string" + }, + "com.amazonaws.backupstorage#ServiceInternalException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Deprecated. To be removed from the model.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.backupstorage#ServiceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Retryable exception, indicates internal server error.", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.backupstorage#StartObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#StartObjectInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#StartObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#DataAlreadyExistsException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Start upload containing one or many chunks.", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/object/{ObjectName}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#StartObjectInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Name for the object.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThrowOnDuplicate": { + "target": "com.amazonaws.backupstorage#boolean", + "traits": { + "smithy.api#documentation": "Throw an exception if Object name is already exist." + } + } + } + }, + "com.amazonaws.backupstorage#StartObjectOutput": { + "type": "structure", + "members": { + "UploadId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Upload Id for a given upload.", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#SummaryChecksumAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUMMARY", + "name": "SUMMARY" + } + ] + } + }, + "com.amazonaws.backupstorage#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Increased rate over throttling limits. Can be retried with exponential backoff.", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.backupstorage#boolean": { + "type": "boolean" + }, + "com.amazonaws.backupstorage#long": { + "type": "long" + }, + "com.amazonaws.backupstorage#string": { + "type": "string" + }, + "com.amazonaws.backupstorage#timestamp": { + "type": "timestamp" + } + } +} diff --git a/codegen/sdk/aws-models/chime-sdk-media-pipelines.json b/codegen/sdk/aws-models/chime-sdk-media-pipelines.json index 4d2650ca15c..218f3580d15 100644 --- a/codegen/sdk/aws-models/chime-sdk-media-pipelines.json +++ b/codegen/sdk/aws-models/chime-sdk-media-pipelines.json @@ -50,6 +50,78 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationConfiguration": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.chimesdkmediapipelines#AudioConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the audio artifacts concatenation.

", + "smithy.api#required": {} + } + }, + "Video": { + "target": "com.amazonaws.chimesdkmediapipelines#VideoConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the video artifacts concatenation.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmediapipelines#ContentConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the content artifacts concatenation.

", + "smithy.api#required": {} + } + }, + "DataChannel": { + "target": "com.amazonaws.chimesdkmediapipelines#DataChannelConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the data channel artifacts concatenation.

", + "smithy.api#required": {} + } + }, + "TranscriptionMessages": { + "target": "com.amazonaws.chimesdkmediapipelines#TranscriptionMessagesConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the transcription messages artifacts concatenation.

", + "smithy.api#required": {} + } + }, + "MeetingEvents": { + "target": "com.amazonaws.chimesdkmediapipelines#MeetingEventsConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the meeting events artifacts concatenation.

", + "smithy.api#required": {} + } + }, + "CompositedVideo": { + "target": "com.amazonaws.chimesdkmediapipelines#CompositedVideoConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the composited video artifacts concatenation.

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

The configuration for the artifacts concatenation.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, "com.amazonaws.chimesdkmediapipelines#ArtifactsConfiguration": { "type": "structure", "members": { @@ -73,6 +145,12 @@ "smithy.api#documentation": "

The configuration for the content artifacts.

", "smithy.api#required": {} } + }, + "CompositedVideo": { + "target": "com.amazonaws.chimesdkmediapipelines#CompositedVideoArtifactsConfiguration", + "traits": { + "smithy.api#documentation": "

Enables video compositing.

" + } } }, "traits": { @@ -105,6 +183,17 @@ } } }, + "com.amazonaws.chimesdkmediapipelines#AudioArtifactsConcatenationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + } + ] + } + }, "com.amazonaws.chimesdkmediapipelines#AudioArtifactsConfiguration": { "type": "structure", "members": { @@ -120,6 +209,36 @@ "smithy.api#documentation": "

The audio artifact configuration object.

" } }, + "com.amazonaws.chimesdkmediapipelines#AudioChannelsOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Stereo", + "name": "Stereo" + }, + { + "value": "Mono", + "name": "Mono" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#AudioConcatenationConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#AudioArtifactsConcatenationState", + "traits": { + "smithy.api#documentation": "

Enables the name object, where name \n is the name of the configuration object, such as AudioConcatenation.

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

The audio artifact concatenation configuration object.

" + } + }, "com.amazonaws.chimesdkmediapipelines#AudioMuxType": { "type": "string", "traits": { @@ -131,10 +250,20 @@ { "value": "AudioWithActiveSpeakerVideo", "name": "AudioWithActiveSpeakerVideo" + }, + { + "value": "AudioWithCompositedVideo", + "name": "AudioWithCompositedVideo" } ] } }, + "com.amazonaws.chimesdkmediapipelines#AudioSampleRateOption": { + "type": "string", + "traits": { + "smithy.api#pattern": "^44100|48000$" + } + }, "com.amazonaws.chimesdkmediapipelines#BadRequestException": { "type": "structure", "members": { @@ -171,7 +300,7 @@ "name": "chime" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines \n and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see \n Amzon Chime SDK media pipelines.\n

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

The Amazon Chime SDK media pipeline APIs in this section allow software developers to\n create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipleines, see Amazon Chime SDK media pipelines.

", "smithy.api#title": "Amazon Chime SDK Media Pipelines" }, "version": "2021-07-15", @@ -179,15 +308,30 @@ { "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipeline" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaConcatenationPipeline" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaLiveConnectorPipeline" + }, { "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipeline" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipeline" + }, { "target": "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipeline" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaPipeline" + }, { "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelines" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaPipelines" + }, { "target": "com.amazonaws.chimesdkmediapipelines#ListTagsForResource" }, @@ -199,13 +343,28 @@ } ] }, + "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConcatenationConfiguration": { + "type": "structure", + "members": { + "ArtifactsConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.

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

The configuration object of the Amazon Chime SDK meeting concatenation for a specified\n media pipeline.

" + } + }, "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConfiguration": { "type": "structure", "members": { "SourceConfiguration": { "target": "com.amazonaws.chimesdkmediapipelines#SourceConfiguration", "traits": { - "smithy.api#documentation": "

The source configuration for a specified media capture pipline.

" + "smithy.api#documentation": "

The source configuration for a specified media pipline.

" } }, "ArtifactsConfiguration": { @@ -216,7 +375,41 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

" + "smithy.api#documentation": "

The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. SourceType must be ChimeSdkMeeting.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingLiveConnectorConfiguration": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "

The configuration object's Chime SDK meeting ARN.

", + "smithy.api#required": {} + } + }, + "MuxType": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorMuxType", + "traits": { + "smithy.api#documentation": "

The configuration object's multiplex type.

", + "smithy.api#required": {} + } + }, + "CompositedVideo": { + "target": "com.amazonaws.chimesdkmediapipelines#CompositedVideoArtifactsConfiguration", + "traits": { + "smithy.api#documentation": "

The media pipeline's composited video.

" + } + }, + "SourceConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#SourceConfiguration", + "traits": { + "smithy.api#documentation": "

The source configuration settings of the media pipeline's configuration object.

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

The media pipeline's configuration object.

" } }, "com.amazonaws.chimesdkmediapipelines#ClientRequestToken": { @@ -230,6 +423,138 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmediapipelines#CompositedVideoArtifactsConfiguration": { + "type": "structure", + "members": { + "Layout": { + "target": "com.amazonaws.chimesdkmediapipelines#LayoutOption", + "traits": { + "smithy.api#documentation": "

The layout setting, such as GridView in the configuration object.

" + } + }, + "Resolution": { + "target": "com.amazonaws.chimesdkmediapipelines#ResolutionOption", + "traits": { + "smithy.api#documentation": "

The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

" + } + }, + "GridViewConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#GridViewConfiguration", + "traits": { + "smithy.api#documentation": "

The GridView configuration setting.

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

Describes the configuration for the composited video artifacts.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#CompositedVideoConcatenationConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationState", + "traits": { + "smithy.api#documentation": "

Enables or disables the configuration object.

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

The composited video configuration object for a specified\n media pipeline. SourceType must be\n ChimeSdkMeeting.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ConcatenationSink": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSinkType", + "traits": { + "smithy.api#documentation": "

The type of data sink in the configuration object.

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

The configuration settings for an Amazon S3 bucket sink.

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

The data sink of the configuration object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ConcatenationSinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSink" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ConcatenationSinkType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "S3Bucket", + "name": "S3Bucket" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#ConcatenationSource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSourceType", + "traits": { + "smithy.api#documentation": "

The type of concatenation source in a configuration object.

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

The concatenation settings for the media pipeline in a configuration object.

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

The source type and media pipeline configuration settings in a configuration object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ConcatenationSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ConcatenationSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MediaCapturePipeline", + "name": "MediaCapturePipeline" + } + ] + } + }, "com.amazonaws.chimesdkmediapipelines#ContentArtifactsConfiguration": { "type": "structure", "members": { @@ -251,6 +576,21 @@ "smithy.api#documentation": "

The content artifact object.

" } }, + "com.amazonaws.chimesdkmediapipelines#ContentConcatenationConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationState", + "traits": { + "smithy.api#documentation": "

Enables or disables the configuration object.

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

The composited content configuration object for a specified\n media pipeline.

" + } + }, "com.amazonaws.chimesdkmediapipelines#ContentMuxType": { "type": "string", "traits": { @@ -262,6 +602,25 @@ ] } }, + "com.amazonaws.chimesdkmediapipelines#ContentShareLayoutOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PresenterOnly", + "name": "PresenterOnly" + }, + { + "value": "Horizontal", + "name": "Horizontal" + }, + { + "value": "Vertical", + "name": "Vertical" + } + ] + } + }, "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipeline": { "type": "operation", "input": { @@ -294,7 +653,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a media capture pipeline.

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

Creates a media pipeline.

", "smithy.api#http": { "method": "POST", "uri": "/sdk-media-capture-pipelines", @@ -308,7 +667,7 @@ "SourceType": { "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSourceType", "traits": { - "smithy.api#documentation": "

Source type from which the media artifacts are captured. A Chime SDK Meeting \n is the only supported source.

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

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only\n supported source.

", "smithy.api#required": {} } }, @@ -322,7 +681,7 @@ "SinkType": { "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSinkType", "traits": { - "smithy.api#documentation": "

Destination type to which the media artifacts are saved. You must use an S3 bucket.

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

Destination type to which the media artifacts are saved. You must use an S3 bucket.

", "smithy.api#required": {} } }, @@ -336,20 +695,20 @@ "ClientRequestToken": { "target": "com.amazonaws.chimesdkmediapipelines#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The token assigned to the client making the pipeline request.

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

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

", "smithy.api#idempotencyToken": {} } }, "ChimeSdkMeetingConfiguration": { "target": "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

" + "smithy.api#documentation": "

The configuration for a specified media pipeline. SourceType must\n be ChimeSdkMeeting.

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

The list of tags.

" + "smithy.api#documentation": "

The tag key-value pairs.

" } } } @@ -360,18 +719,18 @@ "MediaCapturePipeline": { "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipeline", "traits": { - "smithy.api#documentation": "

A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.

" + "smithy.api#documentation": "

A media pipeline object, the ID, source type, source ARN, sink type, and sink\n ARN of a media pipeline object.

" } } } }, - "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipeline": { + "com.amazonaws.chimesdkmediapipelines#CreateMediaConcatenationPipeline": { "type": "operation", "input": { - "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipelineRequest" + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaConcatenationPipelineRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaConcatenationPipelineResponse" }, "errors": [ { @@ -381,7 +740,7 @@ "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" }, { - "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" }, { "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" @@ -397,7 +756,188 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the media capture pipeline.

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

Creates a media concatenation pipeline.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sdk-media-concatenation-pipelines", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaConcatenationPipelineRequest": { + "type": "structure", + "members": { + "Sources": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSourceList", + "traits": { + "smithy.api#documentation": "

An object that specifies the sources for the media concatenation pipeline.

", + "smithy.api#required": {} + } + }, + "Sinks": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSinkList", + "traits": { + "smithy.api#documentation": "

An object that specifies the data sinks for the media concatenation pipeline.

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

The unique identifier for the client request. The token makes the API request\n idempotent. Use a unique token for each media concatenation pipeline request.

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

The tags associated with the media concatenation pipeline.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaConcatenationPipelineResponse": { + "type": "structure", + "members": { + "MediaConcatenationPipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaConcatenationPipeline", + "traits": { + "smithy.api#documentation": "

A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a\n media concatenation pipeline object.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaLiveConnectorPipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaLiveConnectorPipelineRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaLiveConnectorPipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a streaming media pipeline in an Amazon Chime SDK meeting.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sdk-media-live-connector-pipelines", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaLiveConnectorPipelineRequest": { + "type": "structure", + "members": { + "Sources": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSourceList", + "traits": { + "smithy.api#documentation": "

The media pipeline's data sources.

", + "smithy.api#required": {} + } + }, + "Sinks": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSinkList", + "traits": { + "smithy.api#documentation": "

The media pipeline's data sinks.

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

The token assigned to the client making the request.

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

The tags associated with the media pipeline.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaLiveConnectorPipelineResponse": { + "type": "structure", + "members": { + "MediaLiveConnectorPipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaLiveConnectorPipeline", + "traits": { + "smithy.api#documentation": "

The new media pipeline.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#DataChannelConcatenationConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationState", + "traits": { + "smithy.api#documentation": "

Enables or disables the configuration object.

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

The content configuration object's data channel.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipelineRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the media pipeline.

", "smithy.api#http": { "method": "DELETE", "uri": "/sdk-media-capture-pipelines/{MediaPipelineId}", @@ -411,7 +951,60 @@ "MediaPipelineId": { "target": "com.amazonaws.chimesdkmediapipelines#GuidString", "traits": { - "smithy.api#documentation": "

The ID of the media capture pipeline being deleted.

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

The ID of the media pipeline being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipelineRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the media pipeline.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sdk-media-pipelines/{MediaPipelineId}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipelineRequest": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the media pipeline to delete.

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

Gets an existing media capture pipeline.

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

Gets an existing media pipeline.

", "smithy.api#http": { "method": "GET", "uri": "/sdk-media-capture-pipelines/{MediaPipelineId}", @@ -555,11 +1148,96 @@ "MediaCapturePipeline": { "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipeline", "traits": { - "smithy.api#documentation": "

The media capture pipeline object.

" + "smithy.api#documentation": "

The media pipeline object.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaPipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an existing media pipeline.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sdk-media-pipelines/{MediaPipelineId}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineRequest": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the pipeline that you want to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineResponse": { + "type": "structure", + "members": { + "MediaPipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipeline", + "traits": { + "smithy.api#documentation": "

The media pipeline object.

" } } } }, + "com.amazonaws.chimesdkmediapipelines#GridViewConfiguration": { + "type": "structure", + "members": { + "ContentShareLayout": { + "target": "com.amazonaws.chimesdkmediapipelines#ContentShareLayoutOption", + "traits": { + "smithy.api#documentation": "

Defines the layout of the video tiles when content sharing is enabled.

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

Defines the configuration options for a presenter only video tile.

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

Specifies the type of grid layout.

" + } + }, "com.amazonaws.chimesdkmediapipelines#GuidString": { "type": "string", "traits": { @@ -576,6 +1254,17 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.chimesdkmediapipelines#LayoutOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GridView", + "name": "GridView" + } + ] + } + }, "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelines": { "type": "operation", "input": { @@ -608,7 +1297,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of media capture pipelines.

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

Returns a list of media pipelines.

", "smithy.api#http": { "method": "GET", "uri": "/sdk-media-capture-pipelines", @@ -646,7 +1335,88 @@ "MediaCapturePipelines": { "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummaryList", "traits": { - "smithy.api#documentation": "

The media capture pipeline objects in the list.

" + "smithy.api#documentation": "

The media pipeline objects in the list.

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

The token used to retrieve the next page of results.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaPipelines": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaPipelinesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaPipelinesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of media pipelines.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sdk-media-pipelines", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaPipelinesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The token used to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmediapipelines#ResultMax", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. Valid Range: 1 - 99.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaPipelinesResponse": { + "type": "structure", + "members": { + "MediaPipelines": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineList", + "traits": { + "smithy.api#documentation": "

The media pipeline objects in the list.

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

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

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

Lists the tags available for a media pipeline.

", "smithy.api#http": { "method": "GET", "uri": "/tags", @@ -697,49 +1467,181 @@ } } }, - "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceRequest": { + "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.

", + "smithy.api#httpQuery": "arn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.chimesdkmediapipelines#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the specified media pipeline.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#LiveConnectorMuxType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AudioWithCompositedVideo", + "name": "AudioWithCompositedVideo" + }, + { + "value": "AudioWithActiveSpeakerVideo", + "name": "AudioWithActiveSpeakerVideo" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#LiveConnectorRTMPConfiguration": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.chimesdkmediapipelines#SensitiveString", + "traits": { + "smithy.api#documentation": "

The URL of the RTMP configuration.

", + "smithy.api#required": {} + } + }, + "AudioChannels": { + "target": "com.amazonaws.chimesdkmediapipelines#AudioChannelsOption", + "traits": { + "smithy.api#documentation": "

The audio channels set for the RTMP configuration

" + } + }, + "AudioSampleRate": { + "target": "com.amazonaws.chimesdkmediapipelines#AudioSampleRateOption", + "traits": { + "smithy.api#documentation": "

The audio sample rate set for the RTMP configuration. Default: 48000.

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

The media pipeline's RTMP configuration object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#LiveConnectorSinkConfiguration": { + "type": "structure", + "members": { + "SinkType": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSinkType", + "traits": { + "smithy.api#documentation": "

The sink configuration's sink type.

", + "smithy.api#required": {} + } + }, + "RTMPConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorRTMPConfiguration", + "traits": { + "smithy.api#documentation": "

The sink configuration's RTMP configuration setttings.

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

The media pipeline's sink configuration settings.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#LiveConnectorSinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSinkConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#LiveConnectorSinkType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RTMP", + "name": "RTMP" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#LiveConnectorSourceConfiguration": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "SourceType": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSourceType", "traits": { - "smithy.api#documentation": "

The resource ARN.

", - "smithy.api#httpQuery": "arn", + "smithy.api#documentation": "

The source configuration's media source type.

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

The configuration settings of the connector pipeline.

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

The data source configuration object of a streaming media pipeline.

" } }, - "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.chimesdkmediapipelines#TagList", - "traits": { - "smithy.api#documentation": "

The tag key-value pairs.

" - } + "com.amazonaws.chimesdkmediapipelines#LiveConnectorSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSourceConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 } } }, + "com.amazonaws.chimesdkmediapipelines#LiveConnectorSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ChimeSdkMeeting", + "name": "ChimeSdkMeeting" + } + ] + } + }, "com.amazonaws.chimesdkmediapipelines#MediaCapturePipeline": { "type": "structure", "members": { "MediaPipelineId": { "target": "com.amazonaws.chimesdkmediapipelines#GuidString", "traits": { - "smithy.api#documentation": "

The ID of a media capture pipeline.

" + "smithy.api#documentation": "

The ID of a media pipeline.

" } }, "MediaPipelineArn": { "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of a media capture pipeline.

" + "smithy.api#documentation": "

The ARN of the media capture pipeline

" } }, "SourceType": { "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSourceType", "traits": { - "smithy.api#documentation": "

Source type from which media artifacts are saved. You must use ChimeMeeting.

" + "smithy.api#documentation": "

Source type from which media artifacts are saved. You must use\n ChimeMeeting.

" } }, "SourceArn": { @@ -751,13 +1653,13 @@ "Status": { "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineStatus", "traits": { - "smithy.api#documentation": "

The status of the media capture pipeline.

" + "smithy.api#documentation": "

The status of the media pipeline.

" } }, "SinkType": { "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSinkType", "traits": { - "smithy.api#documentation": "

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

" + "smithy.api#documentation": "

Destination type to which the media artifacts are saved. You must use an S3\n Bucket.

" } }, "SinkArn": { @@ -769,24 +1671,46 @@ "CreatedTimestamp": { "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the capture pipeline was created, in ISO 8601 format.

" + "smithy.api#documentation": "

The time at which the pipeline was created, in ISO 8601 format.

" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the capture pipeline was updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The time at which the pipeline was updated, in ISO 8601 format.

" } }, "ChimeSdkMeetingConfiguration": { "target": "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

" + "smithy.api#documentation": "

The configuration for a specified media pipeline. SourceType must\n be ChimeSdkMeeting.

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

A media pipeline object consisting of an ID, source type, source ARN, a sink\n type, a sink ARN, and a configuration object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSourceConfiguration": { + "type": "structure", + "members": { + "MediaPipelineArn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "

The media pipeline ARN in the configuration object of a media capture pipeline.

", + "smithy.api#required": {} + } + }, + "ChimeSdkMeetingConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConcatenationConfiguration", + "traits": { + "smithy.api#documentation": "

The meeting configuration settings in a media capture pipeline configuration object.

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

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

" + "smithy.api#documentation": "

The source configuration object of a media capture pipeline.

" } }, "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummary": { @@ -795,18 +1719,18 @@ "MediaPipelineId": { "target": "com.amazonaws.chimesdkmediapipelines#GuidString", "traits": { - "smithy.api#documentation": "

The ID of a media capture pipeline.

" + "smithy.api#documentation": "

The ID of the media pipeline in the summary.

" } }, "MediaPipelineArn": { "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of a media capture pipeline.

" + "smithy.api#documentation": "

The ARN of the media pipeline in the summary.

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

A summary of a media capture pipeline.

" + "smithy.api#documentation": "

The summary data of a media capture pipeline.

" } }, "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummaryList": { @@ -815,6 +1739,138 @@ "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummary" } }, + "com.amazonaws.chimesdkmediapipelines#MediaConcatenationPipeline": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the media pipeline being concatenated.

" + } + }, + "MediaPipelineArn": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the media pipeline that you specify in the SourceConfiguration object.

" + } + }, + "Sources": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSourceList", + "traits": { + "smithy.api#documentation": "

The data sources being concatnated.

" + } + }, + "Sinks": { + "target": "com.amazonaws.chimesdkmediapipelines#ConcatenationSinkList", + "traits": { + "smithy.api#documentation": "

The data sinks of the concatenation pipeline.

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

The status of the concatenation pipeline.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the concatenation pipeline was created.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the concatenation pipeline was last updated.

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

Concatenates audio and video data from one or more data streams.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaLiveConnectorPipeline": { + "type": "structure", + "members": { + "Sources": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSourceList", + "traits": { + "smithy.api#documentation": "

The connector pipeline's data sources.

" + } + }, + "Sinks": { + "target": "com.amazonaws.chimesdkmediapipelines#LiveConnectorSinkList", + "traits": { + "smithy.api#documentation": "

The connector pipeline's data sinks.

" + } + }, + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The connector pipeline's ID.

" + } + }, + "MediaPipelineArn": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The connector pipeline's ARN.

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

The connector pipeline's status.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

Thetime at which the connector pipeline was created.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the connector pipeline was last updated.

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

The connector pipeline.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaPipeline": { + "type": "structure", + "members": { + "MediaCapturePipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipeline", + "traits": { + "smithy.api#documentation": "

A pipeline that enables users to capture audio and video.

" + } + }, + "MediaLiveConnectorPipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaLiveConnectorPipeline", + "traits": { + "smithy.api#documentation": "

The connector pipeline of the media pipeline.

" + } + }, + "MediaConcatenationPipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaConcatenationPipeline", + "traits": { + "smithy.api#documentation": "

The media concatenation pipeline in a media pipeline.

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

A pipeline consisting of a media capture, media concatenation, or live-streaming pipeline.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaPipelineList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSummary" + } + }, "com.amazonaws.chimesdkmediapipelines#MediaPipelineSinkType": { "type": "string", "traits": { @@ -864,6 +1920,41 @@ ] } }, + "com.amazonaws.chimesdkmediapipelines#MediaPipelineSummary": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the media pipeline in the summary.

" + } + }, + "MediaPipelineArn": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the media pipeline in the summary.

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

The summary of the media pipeline.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#MeetingEventsConcatenationConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationState", + "traits": { + "smithy.api#documentation": "

Enables or disables the configuration object.

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

The configuration object for an event concatenation pipeline.

" + } + }, "com.amazonaws.chimesdkmediapipelines#NotFoundException": { "type": "structure", "members": { @@ -886,6 +1977,58 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.chimesdkmediapipelines#PresenterOnlyConfiguration": { + "type": "structure", + "members": { + "PresenterPosition": { + "target": "com.amazonaws.chimesdkmediapipelines#PresenterPosition", + "traits": { + "smithy.api#documentation": "

Defines the position of the presenter video tile. Default: TopRight.

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

Defines the configuration for a presenter only video tile.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#PresenterPosition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TopLeft", + "name": "TopLeft" + }, + { + "value": "TopRight", + "name": "TopRight" + }, + { + "value": "BottomLeft", + "name": "BottomLeft" + }, + { + "value": "BottomRight", + "name": "BottomRight" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#ResolutionOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HD", + "name": "HD" + }, + { + "value": "FHD", + "name": "FHD" + } + ] + } + }, "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException": { "type": "structure", "members": { @@ -918,24 +2061,49 @@ } } }, + "com.amazonaws.chimesdkmediapipelines#S3BucketSinkConfiguration": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "

The destination URL of the S3 bucket.

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

The configuration settings for the S3 bucket.

" + } + }, "com.amazonaws.chimesdkmediapipelines#SelectedVideoStreams": { "type": "structure", "members": { "AttendeeIds": { "target": "com.amazonaws.chimesdkmediapipelines#AttendeeIdList", "traits": { - "smithy.api#documentation": "

The attendee IDs of the streams selected for a media capture pipeline.

" + "smithy.api#documentation": "

The attendee IDs of the streams selected for a media pipeline.

" } }, "ExternalUserIds": { "target": "com.amazonaws.chimesdkmediapipelines#ExternalUserIdList", "traits": { - "smithy.api#documentation": "

The external user IDs of the streams selected for a media capture pipeline.

" + "smithy.api#documentation": "

The external user IDs of the streams selected for a media pipeline.

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

The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.

" + "smithy.api#documentation": "

The video streams for a specified media pipeline. The total number of\n video streams can't exceed 25.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkmediapipelines#ServiceFailureException": { @@ -988,12 +2156,12 @@ "SelectedVideoStreams": { "target": "com.amazonaws.chimesdkmediapipelines#SelectedVideoStreams", "traits": { - "smithy.api#documentation": "

The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.

" + "smithy.api#documentation": "

The selected video streams for a specified media pipeline. The number\n of video streams can't exceed 25.

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

Source configuration for a specified media capture pipeline.

" + "smithy.api#documentation": "

Source configuration for a specified media pipeline.

" } }, "com.amazonaws.chimesdkmediapipelines#String": { @@ -1012,20 +2180,20 @@ "Key": { "target": "com.amazonaws.chimesdkmediapipelines#TagKey", "traits": { - "smithy.api#documentation": "

The key of the tag.

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

The key half of a tag.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.chimesdkmediapipelines#TagValue", "traits": { - "smithy.api#documentation": "

The value of the tag.

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

The value half of a tag.

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

Describes a tag applied to a resource.

" + "smithy.api#documentation": "

A key/value pair that grants users access to meeting resources.

" } }, "com.amazonaws.chimesdkmediapipelines#TagKey": { @@ -1093,7 +2261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

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

The ARN of the media pipeline that you want to tag. Consists of he pipeline's endpoint region, resource ID, and pipeline ID.

", "smithy.api#http": { "method": "POST", "uri": "/tags?operation=tag-resource", @@ -1107,14 +2275,14 @@ "ResourceARN": { "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The resource ARN.

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

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chimesdkmediapipelines#TagList", "traits": { - "smithy.api#documentation": "

The tag key-value pairs.

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

The tags associated with the specified media pipeline.

", "smithy.api#required": {} } } @@ -1155,6 +2323,21 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.chimesdkmediapipelines#TranscriptionMessagesConcatenationConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationState", + "traits": { + "smithy.api#documentation": "

Enables or disables the configuration object.

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

The configuration object for concatenating transcription messages.

" + } + }, "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException": { "type": "structure", "members": { @@ -1209,7 +2392,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

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

Removes any tags from a media pipeline.

", "smithy.api#http": { "method": "POST", "uri": "/tags?operation=untag-resource", @@ -1223,14 +2406,14 @@ "ResourceARN": { "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The resource ARN.

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

The ARN of the pipeline that you want to untag.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.chimesdkmediapipelines#TagKeyList", "traits": { - "smithy.api#documentation": "

The tag keys.

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

The key/value pairs in the tag that you want to remove.

", "smithy.api#required": {} } } @@ -1261,6 +2444,21 @@ "smithy.api#documentation": "

The video artifact configuration object.

" } }, + "com.amazonaws.chimesdkmediapipelines#VideoConcatenationConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConcatenationState", + "traits": { + "smithy.api#documentation": "

Enables or disables the configuration object.

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

The configuration object of a video contacatentation pipeline.

" + } + }, "com.amazonaws.chimesdkmediapipelines#VideoMuxType": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/chime-sdk-meetings.json b/codegen/sdk/aws-models/chime-sdk-meetings.json index 29e7447fd7c..aa03ffc6198 100644 --- a/codegen/sdk/aws-models/chime-sdk-meetings.json +++ b/codegen/sdk/aws-models/chime-sdk-meetings.json @@ -29,6 +29,16 @@ ] }, "shapes": { + "com.amazonaws.chimesdkmeetings#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:" + } + }, "com.amazonaws.chimesdkmeetings#Arn": { "type": "string", "traits": { @@ -375,12 +385,21 @@ { "target": "com.amazonaws.chimesdkmeetings#ListAttendees" }, + { + "target": "com.amazonaws.chimesdkmeetings#ListTagsForResource" + }, { "target": "com.amazonaws.chimesdkmeetings#StartMeetingTranscription" }, { "target": "com.amazonaws.chimesdkmeetings#StopMeetingTranscription" }, + { + "target": "com.amazonaws.chimesdkmeetings#TagResource" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UntagResource" + }, { "target": "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilities" } @@ -407,7 +426,10 @@ "target": "com.amazonaws.chimesdkmeetings#String" }, "RequestId": { - "target": "com.amazonaws.chimesdkmeetings#String" + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "

The ID of the request involved in the conflict.

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

A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

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

Applies one or more tags to an Amazon Chime SDK meeting. Note the following:

\n \n \n

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be \n used for private or sensitive data.

\n \n

\n Minimum permissions\n

\n \n

In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, \n to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions:

\n \n

\n tag:TagResources\n

\n \n

\n ChimeSDKMeetings:CreateTags\n

\n \n \n

Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. \n If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.

\n " + } } } }, @@ -767,6 +795,12 @@ "traits": { "smithy.api#documentation": "

A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

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

The tags in the request.

" + } } } }, @@ -1363,6 +1397,52 @@ } } }, + "com.amazonaws.chimesdkmeetings#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the tags available for the specified resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmeetings#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpQuery": "arn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.chimesdkmeetings#TagList", + "traits": { + "smithy.api#documentation": "

The tags requested for the specified resource.

" + } + } + } + }, "com.amazonaws.chimesdkmeetings#MediaCapabilities": { "type": "string", "traits": { @@ -1501,6 +1581,12 @@ "traits": { "smithy.api#documentation": "

Array of strings.

" } + }, + "MeetingArn": { + "target": "com.amazonaws.chimesdkmeetings#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the meeting.

" + } } }, "traits": { @@ -1593,6 +1679,34 @@ } } }, + "com.amazonaws.chimesdkmeetings#ResourceNotFoundException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that couldn't be found.

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

The name of the resource that couldn't be found.

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

The resource that you want to tag couldn't be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.chimesdkmeetings#ResultMax": { "type": "integer", "traits": { @@ -1616,7 +1730,10 @@ "target": "com.amazonaws.chimesdkmeetings#String" }, "RequestId": { - "target": "com.amazonaws.chimesdkmeetings#String" + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "

The ID of the failed request.

" + } } }, "traits": { @@ -1785,6 +1902,123 @@ } } }, + "com.amazonaws.chimesdkmeetings#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.chimesdkmeetings#TagKey", + "traits": { + "smithy.api#documentation": "

The tag's key.

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

The tag's value.

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

A key-value pair that you define.

" + } + }, + "com.amazonaws.chimesdkmeetings#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.chimesdkmeetings#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmeetings#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkmeetings#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmeetings#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkmeetings#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

The resource that supports tags.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=tag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmeetings#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmeetings#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

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

Lists the requested tags.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.chimesdkmeetings#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" + } + }, "com.amazonaws.chimesdkmeetings#TenantId": { "type": "string", "traits": { @@ -1817,7 +2051,10 @@ "target": "com.amazonaws.chimesdkmeetings#String" }, "RequestId": { - "target": "com.amazonaws.chimesdkmeetings#String" + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that exceeded the throttling limit.

" + } } }, "traits": { @@ -1826,6 +2063,34 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.chimesdkmeetings#TooManyTagsException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that contains too many tags.

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

The name of the resource that received too many tags.

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

Too many tags were added to the specified resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.chimesdkmeetings#TranscribeContentIdentificationType": { "type": "string", "traits": { @@ -2197,6 +2462,54 @@ "smithy.api#httpError": 422 } }, + "com.amazonaws.chimesdkmeetings#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you \n attempt to remove tags from a resource that were already removed. Note the following:

\n \n \n

\n Minimum permissions\n

\n \n

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. \n For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

\n \n

\n tag:UntagResource\n

\n \n

\n ChimeSDKMeetings:DeleteTags\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=untag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmeetings#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmeetings#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that you're removing tags from.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.chimesdkmeetings#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys being removed from the resources.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilities": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/chime-sdk-messaging.json b/codegen/sdk/aws-models/chime-sdk-messaging.json index 4e0f4dc6584..c299faa4b0a 100644 --- a/codegen/sdk/aws-models/chime-sdk-messaging.json +++ b/codegen/sdk/aws-models/chime-sdk-messaging.json @@ -62,6 +62,12 @@ "traits": { "smithy.api#documentation": "

The time at which an AppInstanceUser last marked a channel as read.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel that the AppInstanceUser is a member of.

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

The ARN of the channel to which you're adding users.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel.

" + } } }, "traits": { @@ -202,6 +214,12 @@ { "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" }, + { + "target": "com.amazonaws.chimesdkmessaging#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException" + }, { "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" }, @@ -287,6 +305,12 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

\n " + } } } }, @@ -378,6 +402,12 @@ "traits": { "smithy.api#documentation": "

The ARN of the channel flow.

" } + }, + "ElasticChannelConfiguration": { + "target": "com.amazonaws.chimesdkmessaging#ElasticChannelConfiguration", + "traits": { + "smithy.api#documentation": "

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

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

The time at which a channel membership was last updated.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel that a user belongs to.

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

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel.

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

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel.

" + } } }, "traits": { @@ -1369,6 +1417,9 @@ { "target": "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUser" }, + { + "target": "com.amazonaws.chimesdkmessaging#ListSubChannels" + }, { "target": "com.amazonaws.chimesdkmessaging#ListTagsForResource" }, @@ -1684,6 +1735,9 @@ { "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" }, + { + "target": "com.amazonaws.chimesdkmessaging#NotFoundException" + }, { "target": "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException" }, @@ -1741,6 +1795,12 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

\n " + } } } }, @@ -1758,6 +1818,12 @@ "traits": { "smithy.api#documentation": "

The ARN and metadata of the member being added.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the response.

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

The ARNs of the channel moderators in the request.

" } + }, + "ElasticChannelConfiguration": { + "target": "com.amazonaws.chimesdkmessaging#ElasticChannelConfiguration", + "traits": { + "smithy.api#documentation": "

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

" + } } } }, @@ -2159,6 +2231,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only for use by moderators.

\n ", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -2225,6 +2304,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when deleting messages in a SubChannel that the user belongs to.

\n ", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -2312,6 +2398,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -2636,6 +2729,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

\n \n

Only required to get a user’s SubChannel membership details.

\n ", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -2911,6 +3011,35 @@ } } }, + "com.amazonaws.chimesdkmessaging#ElasticChannelConfiguration": { + "type": "structure", + "members": { + "MaximumSubChannels": { + "target": "com.amazonaws.chimesdkmessaging#MaximumSubChannels", + "traits": { + "smithy.api#documentation": "

The maximum number of SubChannels that you want to allow in the elastic channel.

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

The maximum number of members allowed in a SubChannel.

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

The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.

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

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

" + } + }, "com.amazonaws.chimesdkmessaging#ErrorCode": { "type": "string", "traits": { @@ -3174,6 +3303,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when getting messages in a SubChannel that the user belongs to.

\n ", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -3251,6 +3387,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when getting message status in a SubChannel that the user belongs to.

\n ", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -3737,6 +3880,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when listing a user's memberships in a particular sub-channel of an elastic channel.

\n ", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -3858,6 +4008,13 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when listing the messages in a SubChannel that the user belongs to.

\n ", + "smithy.api#httpQuery": "sub-channel-id" + } } } }, @@ -3881,6 +4038,12 @@ "traits": { "smithy.api#documentation": "

The information about, and content of, each requested message.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the response.

" + } } } }, @@ -4264,6 +4427,106 @@ } } }, + "com.amazonaws.chimesdkmessaging#ListSubChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListSubChannelsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListSubChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/subchannels", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListSubChannelsRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of elastic channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user making the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of sub-channels that you want to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested sub-channels are returned.

", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListSubChannelsResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of elastic channel.

" + } + }, + "SubChannels": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelSummaryList", + "traits": { + "smithy.api#documentation": "

The information about each sub-channel.

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

The token passed by previous API calls until all requested sub-channels are returned.

" + } + } + } + }, "com.amazonaws.chimesdkmessaging#ListTagsForResource": { "type": "operation", "input": { @@ -4335,6 +4598,15 @@ } } }, + "com.amazonaws.chimesdkmessaging#MaximumSubChannels": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 2 + } + } + }, "com.amazonaws.chimesdkmessaging#MemberArns": { "type": "list", "member": { @@ -4353,6 +4625,12 @@ "target": "com.amazonaws.chimesdkmessaging#Identity" } }, + "com.amazonaws.chimesdkmessaging#MembershipCount": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.chimesdkmessaging#MessageAttributeMap": { "type": "map", "key": { @@ -4439,6 +4717,16 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmessaging#MinimumMembershipPercentage": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 40 + } + } + }, "com.amazonaws.chimesdkmessaging#NextToken": { "type": "string", "traits": { @@ -4802,6 +5090,12 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

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

The ID of the message being redacted.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the response.

\n \n

Only required when redacting messages in a SubChannel that the user belongs to.

\n " + } } } }, @@ -5135,6 +5435,12 @@ "traits": { "smithy.api#documentation": "

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

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

The status of the channel message.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the response.

" + } } } }, @@ -5221,6 +5533,42 @@ "com.amazonaws.chimesdkmessaging#String": { "type": "string" }, + "com.amazonaws.chimesdkmessaging#SubChannelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[-_a-zA-Z0-9]*$" + } + }, + "com.amazonaws.chimesdkmessaging#SubChannelSummary": { + "type": "structure", + "members": { + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The unique ID of a SubChannel.

" + } + }, + "MembershipCount": { + "target": "com.amazonaws.chimesdkmessaging#MembershipCount", + "traits": { + "smithy.api#documentation": "

The number of members in a SubChannel.

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

Summary of the sub-channels associated with the elastic channel.

" + } + }, + "com.amazonaws.chimesdkmessaging#SubChannelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelSummary" + } + }, "com.amazonaws.chimesdkmessaging#Tag": { "type": "structure", "members": { @@ -5346,6 +5694,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmessaging#TargetMembershipsPerSubChannel": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 2 + } + } + }, "com.amazonaws.chimesdkmessaging#ThrottledClientException": { "type": "structure", "members": { @@ -5633,6 +5990,12 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

\n \n

Only required when updating messages in a SubChannel that the user belongs to.

\n " + } } } }, @@ -5656,6 +6019,12 @@ "traits": { "smithy.api#documentation": "

The status of the message update.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the response.

" + } } } }, @@ -5717,6 +6086,12 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the request.

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

The ARN of the channel.

" } + }, + "SubChannelId": { + "target": "com.amazonaws.chimesdkmessaging#SubChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the SubChannel in the response.

" + } } } }, diff --git a/codegen/sdk/aws-models/cloudfront.json b/codegen/sdk/aws-models/cloudfront.json index cb590c05b44..3b9b57fcf52 100644 --- a/codegen/sdk/aws-models/cloudfront.json +++ b/codegen/sdk/aws-models/cloudfront.json @@ -4321,7 +4321,7 @@ "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { - "smithy.api#documentation": "

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate \n\t\t\twith CloudFront. The default value for new web distributions is http2. Viewers that don't support \n\t\t\tHTTP/2 automatically use an earlier HTTP version.

\n\t\t

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must \n\t\t\tsupport Server Name Identification (SNI).

\n\t\t

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. \n\t\t\tYou can improve performance by optimizing for HTTP/2. For more information, do an Internet \n\t\t\tsearch for \"http/2 optimization.\"

" + "smithy.api#documentation": "

(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate\n\t\t\twith CloudFront. The default value for new web distributions is http2. Viewers\n\t\t\tthat don't support HTTP/2 automatically use an earlier HTTP version.

\n\t\t

For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must \n\t\t\tsupport Server Name Indication (SNI).

\n\t\t

For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name\n\t\t\tIndication (SNI). CloudFront supports HTTP/3 connection migration to allow the\n\t\t\tviewer to switch networks without losing connection. For more information\n\t\t\tabout connection migration, see Connection Migration at RFC 9000. For more information about\n\t\t\tsupported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.

" } }, "IsIPV6Enabled": { @@ -7056,6 +7056,14 @@ { "value": "http2", "name": "http2" + }, + { + "value": "http3", + "name": "http3" + }, + { + "value": "http2and3", + "name": "http2and3" } ] } diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index f7d974be62b..e268b7f1388 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -851,7 +851,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified anomaly detection model from your account.

" + "smithy.api#documentation": "

\n\t\t\tDeletes the specified anomaly detection model \n\t\t\tfrom your account.\n\t\t\tFor more information \n\t\t\tabout \n\t\t\thow to delete an anomaly detection model, \n\t\t\tsee Deleting an anomaly detection model \n\t\t\tin the CloudWatch User Guide. \n\t\t

" } }, "com.amazonaws.cloudwatch#DeleteAnomalyDetectorInput": { @@ -1356,7 +1356,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the anomaly detection models that you have created in your account.\n\t\t\tFor single metric anomaly detectors, \n\t\t\tyou can list all of the models in your account or filter the results \n\t\t\tto only the models that are related to a certain namespace, metric name, or metric dimension.\n\t\t\tFor metric math anomaly detectors, \n\t\t\tyou can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. \n\t\t\tThis will return all metric math anomaly detectors in your account.

" + "smithy.api#documentation": "

Lists the anomaly detection models that you have created in your account.\n\t\t\tFor single metric anomaly detectors, \n\t\t\tyou can list all of the models in your account or filter the results \n\t\t\tto only the models that are related to a certain namespace, metric name, or metric dimension.\n\t\t\tFor metric math anomaly detectors, \n\t\t\tyou can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. \n\t\t\tThis will return all metric math anomaly detectors in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AnomalyDetectors", + "pageSize": "MaxResults" + } } }, "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsInput": { @@ -1492,7 +1498,7 @@ } }, "traits": { - "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n\t\t

You \n\t\tcan assign up to 10 dimensions to a metric.

" + "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n\t\t

You \n\t\tcan assign up to 30 dimensions to a metric.

" } }, "com.amazonaws.cloudwatch#DimensionFilter": { @@ -1542,7 +1548,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 255 + "max": 1024 } } }, @@ -1554,7 +1560,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 10 + "max": 30 } } }, @@ -1726,10 +1732,7 @@ "type": "string" }, "com.amazonaws.cloudwatch#ExtendedStatistic": { - "type": "string", - "traits": { - "smithy.api#pattern": "^p(\\d{1,2}(\\.\\d{0,2})?|100)$" - } + "type": "string" }, "com.amazonaws.cloudwatch#ExtendedStatistics": { "type": "list", @@ -2240,7 +2243,7 @@ "OutputFormat": { "target": "com.amazonaws.cloudwatch#MetricStreamOutputFormat", "traits": { - "smithy.api#documentation": "

The output format for the stream. Valid values are json\n\t\t\tand opentelemetry0.7. For more information about metric stream\n\t\t\toutput formats, see \n\t\t\t\n\t\t\t\tMetric streams output formats.

" + "smithy.api#documentation": "

The output format for the stream. \n\t\t\tValid values are json and opentelemetry0.7. \n\t\t\tFor more information about metric stream output formats, \n\t\t\tsee Metric streams output formats.

" } }, "StatisticsConfigurations": { @@ -2377,6 +2380,9 @@ { "target": "com.amazonaws.cloudwatch#ListDashboards" }, + { + "target": "com.amazonaws.cloudwatch#ListManagedInsightRules" + }, { "target": "com.amazonaws.cloudwatch#ListMetrics" }, @@ -2398,6 +2404,9 @@ { "target": "com.amazonaws.cloudwatch#PutInsightRule" }, + { + "target": "com.amazonaws.cloudwatch#PutManagedInsightRules" + }, { "target": "com.amazonaws.cloudwatch#PutMetricAlarm" }, @@ -2491,6 +2500,12 @@ "smithy.api#documentation": "

The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, \n\t\t\tthe value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\t\tRule Syntax.

", "smithy.api#required": {} } + }, + "ManagedRule": { + "target": "com.amazonaws.cloudwatch#InsightRuleIsManaged", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn optional built-in rule that Amazon Web Services manages.\n\t\t

" + } } }, "traits": { @@ -2591,6 +2606,9 @@ "smithy.api#pattern": "^[\\x00-\\x7F]+$" } }, + "com.amazonaws.cloudwatch#InsightRuleIsManaged": { + "type": "boolean" + }, "com.amazonaws.cloudwatch#InsightRuleMaxResults": { "type": "integer", "traits": { @@ -2956,6 +2974,75 @@ } } }, + "com.amazonaws.cloudwatch#ListManagedInsightRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatch#ListManagedInsightRulesInput" + }, + "output": { + "target": "com.amazonaws.cloudwatch#ListManagedInsightRulesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatch#InvalidNextToken" + }, + { + "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

\n\t\t\tReturns a list \n\t\t\tthat contains the number\n\t\t\tof managed Contributor Insights rules \n\t\t\tin your account.\n\t\t\t\n\t\t

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudwatch#ListManagedInsightRulesInput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.cloudwatch#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ARN \n\t\t\tof an Amazon Web Services resource \n\t\t\tthat has managed Contributor Insights rules.\n\t\t

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

\n\t\t\tInclude this value \n\t\t\tto get \n\t\t\tthe next set \n\t\t\tof rules \n\t\t\tif the value was returned \n\t\t\tby the previous operation.\n\t\t

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudwatch#InsightRuleMaxResults", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe maximum number \n\t\t\tof results \n\t\t\tto return \n\t\t\tin one operation. \n\t\t\tIf you omit this parameter, \n\t\t\tthe default number is used.\n\t\t\tThe default number is 100.\n\t\t

" + } + } + } + }, + "com.amazonaws.cloudwatch#ListManagedInsightRulesOutput": { + "type": "structure", + "members": { + "ManagedRules": { + "target": "com.amazonaws.cloudwatch#ManagedRuleDescriptions", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe managed rules\n\t\t\tthat are available \n\t\t\tfor the specified Amazon Web Services resource.\n\t\t

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

\n\t\t\tInclude this value \n\t\t\tto get \n\t\t\tthe next set \n\t\t\tof rules \n\t\t\tif the value was returned \n\t\t\tby the previous operation.\n\t\t

" + } + } + } + }, "com.amazonaws.cloudwatch#ListMetricStreams": { "type": "operation", "input": { @@ -3154,6 +3241,94 @@ } } }, + "com.amazonaws.cloudwatch#ManagedRule": { + "type": "structure", + "members": { + "TemplateName": { + "target": "com.amazonaws.cloudwatch#TemplateName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe template name \n\t\t\tfor the managed Contributor Insights rule, \n\t\t\tas returned \n\t\t\tby ListManagedInsightRules.\n\t\t

", + "smithy.api#required": {} + } + }, + "ResourceARN": { + "target": "com.amazonaws.cloudwatch#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ARN\n\t\t\tof an Amazon Web Services resource\n\t\t\tthat has managed Contributor Insights rules.\n\t\t

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

\n\t\t\tA list \n\t\t\tof key-value pairs \n\t\t\tthat you can associate \n\t\t\twith a managed Contributor Insights rule.\n\t\t\tYou can associate as many as 50 tags \n\t\t\twith a rule.\n\t\t\tTags can help you organize and categorize your resources. \n\t\t\tYou also can use them \n\t\t\tto scope user permissions \n\t\t\tby granting a user permission \n\t\t\tto access or change only the resources\n\t\t\tthat have certain tag values.\n\t\t\tTo associate tags \n\t\t\twith a rule, \n\t\t\tyou must have the cloudwatch:TagResource permission\n\t\t\tin addition \n\t\t\tto the cloudwatch:PutInsightRule permission.\n\t\t\tIf you are using this operation \n\t\t\tto update an existing Contributor Insights rule, \n\t\t\tany tags \n\t\t\tthat you specify \n\t\t\tin this parameter are ignored. \n\t\t\tTo change the tags \n\t\t\tof an existing rule, \n\t\t\tuse TagResource.\n\t\t

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

\n\t\t\tContains the information\n\t\t\tthat's required \n\t\t\tto enable a managed Contributor Insights rule \n\t\t\tfor an Amazon Web Services resource. \n\t\t\t\n\t\t

" + } + }, + "com.amazonaws.cloudwatch#ManagedRuleDescription": { + "type": "structure", + "members": { + "TemplateName": { + "target": "com.amazonaws.cloudwatch#TemplateName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe template name \n\t\t\tfor the managed rule. \n\t\t\tUsed \n\t\t\tto enable managed rules using PutManagedInsightRules.\n\t\t

" + } + }, + "ResourceARN": { + "target": "com.amazonaws.cloudwatch#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tIf a managed rule is enabled,\n\t\t\tthis is the ARN \n\t\t\tfor the related Amazon Web Services resource.\n\t\t

" + } + }, + "RuleState": { + "target": "com.amazonaws.cloudwatch#ManagedRuleState", + "traits": { + "smithy.api#documentation": "

\n\t\t\tDescribes the state \n\t\t\tof a managed rule. \n\t\t\tIf present, \n\t\t\tit contains information \n\t\t\tabout the Contributor Insights rule \n\t\t\tthat contains information \n\t\t\tabout the related Amazon Web Services resource.\n\t\t

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

\n\t\t\tContains information \n\t\t\tabout managed Contributor Insights rules,\n\t\t\tas returned\n\t\t\tby ListManagedInsightRules.\n\t\t\t\n\t\t

" + } + }, + "com.amazonaws.cloudwatch#ManagedRuleDescriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#ManagedRuleDescription" + } + }, + "com.amazonaws.cloudwatch#ManagedRuleState": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.cloudwatch#InsightRuleName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name\n\t\t\tof the Contributor Insights rule \n\t\t\tthat contains data \n\t\t\tfor the specified Amazon Web Services resource.\n\t\t

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.cloudwatch#InsightRuleState", + "traits": { + "smithy.api#documentation": "

\n\t\t\tIndicates whether the rule is enabled or disabled.\n\t\t

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

\n\t\t\tThe status \n\t\t\tof a managed Contributor Insights rule.\n\t\t

" + } + }, + "com.amazonaws.cloudwatch#ManagedRules": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#ManagedRule" + } + }, "com.amazonaws.cloudwatch#MaxRecords": { "type": "integer", "traits": { @@ -3591,7 +3766,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1024 + "max": 2048 } } }, @@ -3793,14 +3968,14 @@ "IncludeMetrics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsIncludeMetrics", "traits": { - "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t100 pairs in the array.

\n\t\t

All metrics that match the combination of metric name and namespace will be streamed\n\t\twith the additional statistics, no matter their dimensions.

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

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t\t100 pairs in the array.

\n\t\t

All metrics that match the combination of metric name and namespace will be streamed\n\t\t\twith the additional statistics, no matter their dimensions.

", "smithy.api#required": {} } }, "AdditionalStatistics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics", "traits": { - "smithy.api#documentation": "

The list of additional statistics that are to be streamed for the metrics listed\n\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n\t\t

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n\t\t

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\ttm98, \n wm90, PR(:300), and so on.

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

The list of additional statistics that are to be streamed for the metrics listed\n\t\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n\t\t

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n\t\t

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\t\ttm98, \n wm90, PR(:300), and so on.

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

This object contains the information for one metric that is to be streamed with \n\t\tadditional statistics.

" + "smithy.api#documentation": "

This object contains the information for one metric that is to be streamed with \n\t\t\tadditional statistics.

" } }, "com.amazonaws.cloudwatch#MetricWidget": { @@ -4222,6 +4397,49 @@ "type": "structure", "members": {} }, + "com.amazonaws.cloudwatch#PutManagedInsightRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatch#PutManagedInsightRulesInput" + }, + "output": { + "target": "com.amazonaws.cloudwatch#PutManagedInsightRulesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

\n\t\t\tCreates a managed Contributor Insights rule \n\t\t\tfor a specified Amazon Web Services resource.\n\t\t\tWhen you enable a managed rule, \n\t\t\tyou create a Contributor Insights rule \n\t\t\tthat collects data \n\t\t\tfrom Amazon Web Services services. \n\t\t\tYou cannot edit these rules \n\t\t\twith PutInsightRule.\n\t\t\tThe rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules.\n\t\t\tIf a previously created managed rule is currently disabled,\n\t\t\ta subsequent call\n\t\t\tto this API will re-enable it.\n\t\t\tUse ListManagedInsightRules \n\t\t\tto describe all available rules. \n\t\t\t\n\t\t

" + } + }, + "com.amazonaws.cloudwatch#PutManagedInsightRulesInput": { + "type": "structure", + "members": { + "ManagedRules": { + "target": "com.amazonaws.cloudwatch#ManagedRules", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA list\n\t\t\tof ManagedRules\n\t\t\tto enable.\n\t\t

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudwatch#PutManagedInsightRulesOutput": { + "type": "structure", + "members": { + "Failures": { + "target": "com.amazonaws.cloudwatch#BatchFailures", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array \n\t\t\tthat lists the rules \n\t\t\tthat could not be enabled.\n\t\t

" + } + } + } + }, "com.amazonaws.cloudwatch#PutMetricAlarm": { "type": "operation", "input": { @@ -4318,7 +4536,7 @@ "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n\t\t

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n\t\t\t

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves predictably.

\n\t\t

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

" + "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n\t\t

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n\t\t\t

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves unpredictably.

\n\t\t

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

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

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n\n\t\t

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n\t\t

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 20 different metrics.

\n\t\t

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n\t\t

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n\n\t\t

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n\t\t

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n\t\t

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

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

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n\n\t\t

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n\t\t

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.

\n\t\t

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n\t\t

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n\n\t\t

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n\t\t

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n\t\t

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n\t\t\t " } }, "com.amazonaws.cloudwatch#PutMetricDataInput": { @@ -4418,7 +4636,7 @@ "MetricData": { "target": "com.amazonaws.cloudwatch#MetricData", "traits": { - "smithy.api#documentation": "

The data for the metric. The array can include no more than 20 metrics per call.

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

The data for the metric. The array can include no more than 1000 metrics per call.

", "smithy.api#required": {} } } @@ -5175,6 +5393,16 @@ } } }, + "com.amazonaws.cloudwatch#TemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9A-Za-z][\\-\\.\\_0-9A-Za-z]{0,126}[0-9A-Za-z]$" + } + }, "com.amazonaws.cloudwatch#Threshold": { "type": "double", "traits": { diff --git a/codegen/sdk/aws-models/cognito-identity-provider.json b/codegen/sdk/aws-models/cognito-identity-provider.json index d0ea83c79bf..cbc0cff5950 100644 --- a/codegen/sdk/aws-models/cognito-identity-provider.json +++ b/codegen/sdk/aws-models/cognito-identity-provider.json @@ -6245,12 +6245,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Success", - "name": "Success" + "value": "Pass", + "name": "Pass" }, { - "value": "Failure", - "name": "Failure" + "value": "Fail", + "name": "Fail" + }, + { + "value": "InProgress", + "name": "InProgress" } ] } @@ -6296,6 +6300,14 @@ { "value": "ForgotPassword", "name": "ForgotPassword" + }, + { + "value": "PasswordChange", + "name": "PasswordChange" + }, + { + "value": "ResendCode", + "name": "ResendCode" } ] } diff --git a/codegen/sdk/aws-models/config-service.json b/codegen/sdk/aws-models/config-service.json index a2907d214d1..478d8ae5d76 100644 --- a/codegen/sdk/aws-models/config-service.json +++ b/codegen/sdk/aws-models/config-service.json @@ -10957,6 +10957,42 @@ { "value": "AWS::AccessAnalyzer::Analyzer", "name": "AccessAnalyzerAnalyzer" + }, + { + "value": "AWS::Athena::WorkGroup", + "name": "AthenaWorkGroup" + }, + { + "value": "AWS::Athena::DataCatalog", + "name": "AthenaDataCatalog" + }, + { + "value": "AWS::Detective::Graph", + "name": "DetectiveGraph" + }, + { + "value": "AWS::GlobalAccelerator::Accelerator", + "name": "GlobalAcceleratorAccelerator" + }, + { + "value": "AWS::GlobalAccelerator::EndpointGroup", + "name": "GlobalAcceleratorEndpointGroup" + }, + { + "value": "AWS::GlobalAccelerator::Listener", + "name": "GlobalAcceleratorListener" + }, + { + "value": "AWS::EC2::TransitGatewayAttachment", + "name": "TransitGatewayAttachment" + }, + { + "value": "AWS::EC2::TransitGatewayRouteTable", + "name": "TransitGatewayRouteTable" + }, + { + "value": "AWS::DMS::Certificate", + "name": "DMSCertificate" } ] } diff --git a/codegen/sdk/aws-models/connectcampaigns.json b/codegen/sdk/aws-models/connectcampaigns.json index 3bbe38c377c..5950002188e 100644 --- a/codegen/sdk/aws-models/connectcampaigns.json +++ b/codegen/sdk/aws-models/connectcampaigns.json @@ -910,6 +910,9 @@ }, { "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" } ], "traits": { @@ -1554,6 +1557,9 @@ }, { "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" } ], "traits": { @@ -1739,6 +1745,9 @@ }, { "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" } ], "traits": { @@ -1830,6 +1839,9 @@ }, { "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" } ], "traits": { @@ -1950,6 +1962,9 @@ }, { "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" } ], "traits": { diff --git a/codegen/sdk/aws-models/database-migration-service.json b/codegen/sdk/aws-models/database-migration-service.json index 1a6391cc6ad..32459c14cab 100644 --- a/codegen/sdk/aws-models/database-migration-service.json +++ b/codegen/sdk/aws-models/database-migration-service.json @@ -958,7 +958,7 @@ "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\", \n \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\",\n \"db2\", db2-zos, \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", \"neptune\", and babelfish.

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

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\", \n \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\",\n \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", and \"neptune\".

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/dlm.json b/codegen/sdk/aws-models/dlm.json index 218b7dc28b5..b1e84f6d590 100644 --- a/codegen/sdk/aws-models/dlm.json +++ b/codegen/sdk/aws-models/dlm.json @@ -48,7 +48,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies an action for an event-based policy.

" + "smithy.api#documentation": "

\n [Event-based policies only] Specifies an action for an event-based policy.

" } }, "com.amazonaws.dlm#ActionList": { @@ -217,7 +217,7 @@ "Location": { "target": "com.amazonaws.dlm#LocationValues", "traits": { - "smithy.api#documentation": "

Specifies the destination for snapshots created by the policy. To create snapshots in the same \n\t\t\tRegion as the source resource, specify CLOUD. To create snapshots on the same \n\t\t\tOutpost as the source resource, specify OUTPOST_LOCAL. If you omit this \n\t\t\tparameter, CLOUD is used by default.

\n\t\t

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same \n\t\t\tRegion as the source resource.

\n\t\t

If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost \n\t\t\tas the source resource, or in the Region of that Outpost.

" + "smithy.api#documentation": "

\n [Snapshot policies only] Specifies the destination for snapshots created by the policy. To create \n\t\t\tsnapshots in the same Region as the source resource, specify CLOUD. To create \n\t\t\tsnapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. \n\t\t\tIf you omit this parameter, CLOUD is used by default.

\n\t\t

If the policy targets resources in an Amazon Web Services Region, then you must create \n\t\t\tsnapshots in the same Region as the source resource. If the policy targets resources on an \n\t\t\tOutpost, then you can create snapshots on the same Outpost as the source resource, or in \n\t\t\tthe Region of that Outpost.

" } }, "Interval": { @@ -246,7 +246,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies when to create snapshots of EBS volumes.

\n\t\t

You must specify either a Cron expression or an interval, interval unit, and start\n\t\t\ttime. You cannot specify both.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.

\n\t\t \n\t\t\t

You must specify either a Cron expression or an interval, interval unit, and start\n\t\t\ttime. You cannot specify both.

\n\t\t " } }, "com.amazonaws.dlm#CronExpression": { @@ -281,7 +281,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a rule for copying shared snapshots across Regions.

" + "smithy.api#documentation": "

\n [Event-based policies only] Specifies a cross-Region copy action for event-based policies.

\n\t\t\n\t\t \n\t\t\t

To specify a cross-Region copy rule for snapshot and AMI policies, use \n\t\t\t\tCrossRegionCopyRule.

\n\t\t " } }, "com.amazonaws.dlm#CrossRegionCopyActionList": { @@ -308,12 +308,12 @@ "IntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { - "smithy.api#documentation": "

The unit of time in which to measure the Interval.

" + "smithy.api#documentation": "

The unit of time in which to measure the Interval. For example, \n\t\t\tto deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and \n\t\t\tIntervalUnit=MONTHS.

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

Specifies an AMI deprecation rule for cross-Region AMI copies created by a cross-Region copy rule.

" + "smithy.api#documentation": "

\n [AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.

" } }, "com.amazonaws.dlm#CrossRegionCopyRetainRule": { @@ -322,18 +322,18 @@ "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { - "smithy.api#documentation": "

The amount of time to retain each snapshot. The maximum is 100 years. This is\n\t\t\tequivalent to 1200 months, 5200 weeks, or 36500 days.

" + "smithy.api#documentation": "

The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. \n\t\t\tThis is equivalent to 1200 months, 5200 weeks, or 36500 days.

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

The unit of time for time-based retention.

" + "smithy.api#documentation": "

The unit of time for time-based retention. For example, to retain a cross-Region copy for \n\t\t\t3 months, specify Interval=3 and IntervalUnit=MONTHS.

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

Specifies the retention rule for cross-Region snapshot copies.

" + "smithy.api#documentation": "

Specifies a retention rule for cross-Region snapshot copies created by snapshot or \n\t\t\tevent-based policies, or cross-Region AMI copies created by AMI policies. After the \n\t\t\tretention period expires, the cross-Region copy is deleted.

" } }, "com.amazonaws.dlm#CrossRegionCopyRule": { @@ -342,7 +342,7 @@ "TargetRegion": { "target": "com.amazonaws.dlm#TargetRegion", "traits": { - "smithy.api#documentation": "

Avoid using this parameter when creating new policies. Instead, use Target\n\t\t\tto specify a target Region or a target Outpost for snapshot copies.

\n\t\t

For policies created before the Target parameter \n\t\t\twas introduced, this parameter indicates the target Region for snapshot copies.

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

Avoid using this parameter when creating new policies. Instead, use \n\t\t\t\tTarget to specify a target Region or a target \n\t\t\t\tOutpost for snapshot copies.

\n\t\t\t

For policies created before the Target parameter \n\t\t\t\twas introduced, this parameter indicates the target Region for snapshot copies.

\t\t\t\n\t\t " } }, "Target": { @@ -367,24 +367,24 @@ "CopyTags": { "target": "com.amazonaws.dlm#CopyTagsNullable", "traits": { - "smithy.api#documentation": "

Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region \n\t\t\tsnapshot copy.

" + "smithy.api#documentation": "

Indicates whether to copy all user-defined tags from the source snapshot or AMI to the \n\t\t\tcross-Region copy.

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

The retention rule that indicates how long snapshot copies are to be retained in the \n\t\t\tdestination Region.

" + "smithy.api#documentation": "

The retention rule that indicates how long the cross-Region snapshot or AMI copies are \n\t\t\tto be retained in the destination Region.

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

The AMI deprecation rule for cross-Region AMI copies created by the rule.

" + "smithy.api#documentation": "

\n [AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

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

Specifies a rule for cross-Region snapshot copies.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] Specifies a cross-Region copy rule for snapshot and AMI policies.

\n\t\t \n\t\t\t

To specify a cross-Region copy action for event-based polices, use \n\t\t\t\tCrossRegionCopyAction.

\n\t\t " } }, "com.amazonaws.dlm#CrossRegionCopyRules": { @@ -467,7 +467,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies an AMI deprecation rule for a schedule.

" + "smithy.api#documentation": "

\n [AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.

\n\t\t

For age-based schedules, you must specify Interval and \n\t\t\tIntervalUnit. For count-based schedules, you must specify \n\t\t\tCount.

" } }, "com.amazonaws.dlm#DescriptionRegex": { @@ -504,7 +504,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the encryption settings for shared snapshots that are copied across Regions.

" + "smithy.api#documentation": "

\n [Event-based policies only] Specifies the encryption settings for cross-Region snapshot copies created by \n\t\t\tevent-based policies.

" } }, "com.amazonaws.dlm#ErrorCode": { @@ -539,7 +539,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies an event that triggers an event-based policy.

" + "smithy.api#documentation": "

\n [Event-based policies only] Specifies an event that activates an event-based policy.

" } }, "com.amazonaws.dlm#EventSource": { @@ -560,7 +560,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies an event that triggers an event-based policy.

" + "smithy.api#documentation": "

\n [Event-based policies only] Specifies an event that activates an event-based policy.

" } }, "com.amazonaws.dlm#EventSourceValues": { @@ -591,6 +591,18 @@ "smithy.api#box": {} } }, + "com.amazonaws.dlm#ExcludeDataVolumeTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.dlm#ExecutionRoleArn": { "type": "string", "traits": { @@ -631,7 +643,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot\n\t\t\trestore based on either a count or a time interval.

" + "smithy.api#documentation": "

\n [Snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by \n\t\t\tsnaspshot policies. You can enable fast snapshot restore based on either a count or a time \n\t\t\tinterval.

" } }, "com.amazonaws.dlm#GetLifecyclePolicies": { @@ -915,7 +927,7 @@ } }, "traits": { - "smithy.api#documentation": "

Detailed information about a lifecycle policy.

" + "smithy.api#documentation": "

\n [All policy types] Detailed information about a snapshot, AMI, or event-based lifecycle policy.

" } }, "com.amazonaws.dlm#LifecyclePolicySummary": { @@ -948,7 +960,7 @@ "PolicyType": { "target": "com.amazonaws.dlm#PolicyTypeValues", "traits": { - "smithy.api#documentation": "

The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy \n\t\t\tmanages the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT \n\t\t\tindicates that the policy manages the lifecycle of EBS-backed AMIs.

" + "smithy.api#documentation": "

The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy \n\t\t\tmanages the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT \n\t\t\tindicates that the policy manages the lifecycle of EBS-backed AMIs. \n\t\t\tEVENT_BASED_POLICY indicates that the policy automates cross-account \n\t\t\tsnapshot copies for snapshots that are shared with your account.

" } } }, @@ -1072,18 +1084,24 @@ "ExcludeBootVolume": { "target": "com.amazonaws.dlm#ExcludeBootVolume", "traits": { - "smithy.api#documentation": "

[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the\n\t\t\troot volume from snapshots created using CreateSnapshots.\n\t\t\tThe default is false.

" + "smithy.api#documentation": "

\n [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume \n\t\t\tsnapshot sets. The default is false. If you specify true, \n\t\t\tthen the root volumes attached to targeted instances will be excluded from the multi-volume \n\t\t\tsnapshot sets created by the policy.

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

Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle \n\t\t\tpolicy runs. true indicates that targeted instances are not rebooted when the policy \n\t\t\truns. false indicates that target instances are rebooted when the policy runs. The \n\t\t\tdefault is true (instances are not rebooted).

" + "smithy.api#documentation": "

\n [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy \n\t\t\truns. true indicates that targeted instances are not rebooted when the policy \n\t\t\truns. false indicates that target instances are rebooted when the policy runs. \n\t\t\tThe default is true (instances are not rebooted).

" + } + }, + "ExcludeDataVolumeTags": { + "target": "com.amazonaws.dlm#ExcludeDataVolumeTagList", + "traits": { + "smithy.api#documentation": "

\n [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from \n\t\t\tmulti-volume snapshot sets.

\n\t\t

If you create a snapshot lifecycle policy that targets instances and you specify tags for \n\t\t\tthis parameter, then data volumes with the specified tags that are attached to targeted \n\t\t\tinstances will be excluded from the multi-volume snapshot sets created by the policy.

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

Specifies optional parameters to add to a policy. The set of valid parameters depends\n\t\t\ton the combination of policy type and resource type.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The \n\t\t\tset of valid parameters depends on the combination of policy type and target resource \n\t\t\ttype.

\n\t\t

If you choose to exclude boot volumes and you specify tags that consequently exclude \n\t\t\tall of the additional data volumes attached to an instance, then Amazon DLM will not create \n\t\t\tany snapshots for the affected instance, and it will emit a SnapshotsCreateFailed \n\t\t\tAmazon CloudWatch metric. For more information, see Monitor your policies \n\t\t\t\tusing Amazon CloudWatch.

" } }, "com.amazonaws.dlm#PolicyArn": { @@ -1112,54 +1130,54 @@ "PolicyType": { "target": "com.amazonaws.dlm#PolicyTypeValues", "traits": { - "smithy.api#documentation": "

The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY \n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

\n\t\t

The default is EBS_SNAPSHOT_MANAGEMENT.

" + "smithy.api#documentation": "

\n [All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY \n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

\n\t\t

The default is EBS_SNAPSHOT_MANAGEMENT.

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

The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to \n\t\t\tcreate snapshots of individual volumes or use INSTANCE to create multi-volume \n\t\t\tsnapshots from the volumes for an instance.

\n\t\t

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" + "smithy.api#documentation": "

\n [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to \n\t\t\tcreate snapshots of individual volumes or use INSTANCE to create multi-volume \n\t\t\tsnapshots from the volumes for an instance.

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

The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, \n\t\t\tspecify CLOUD. If the source resources are located on an Outpost \n\t\t\tin your account, specify OUTPOST.

\n\t\t\t

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources \n\t\t\t\tof the specified type with matching target tags across all of the Outposts in your account.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an \n\t\t\tAmazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost \n\t\t\tin your account, specify OUTPOST.

\n\t\t\t

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources \n\t\t\t\tof the specified type with matching target tags across all of the Outposts in your account.

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

The single tag that identifies targeted resources for this policy.

\n\t\t

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

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

The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy \n\t\t\tcan have up to four schedules—one mandatory schedule and up to three optional schedules.

\n\t\t

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy \n\t\t\tcan have up to four schedules—one mandatory schedule and up to three optional schedules.

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

A set of optional parameters for snapshot and AMI lifecycle policies.

\n\t\t

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

\n\t\t\n\t\t \n\t\t\t

If you are modifying a policy that was created or previously modified using the Amazon \n\t\t\t\tData Lifecycle Manager console, then you must include this parameter and specify either \n\t\t\t\tthe default values or the new values that you require. You can't omit this parameter or \n\t\t\t\tset its values to null.

\n\t\t " } }, "EventSource": { "target": "com.amazonaws.dlm#EventSource", "traits": { - "smithy.api#documentation": "

The event that triggers the event-based policy.

\n\t\t

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

" + "smithy.api#documentation": "

\n [Event-based policies only] The event that activates the event-based policy.

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

The actions to be performed when the event-based policy is triggered. You can specify \n\t\tonly one action per policy.

\n\t\t

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

" + "smithy.api#documentation": "

\n [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify \n\t\t\tonly one action per policy.

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

Specifies the configuration of a lifecycle policy.

" + "smithy.api#documentation": "

\n [All policy types] Specifies the configuration of a lifecycle policy.

" } }, "com.amazonaws.dlm#PolicyId": { @@ -1302,7 +1320,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the retention rule for a lifecycle policy. You can retain snapshots based on\n\t\t\teither a count or a time interval.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies \n\t\t\tor for AMIs created by AMI policies. You can retain snapshots based on either a count or a time interval.

\n\t\t

You must specify either Count, or Interval \n\t\t\tand IntervalUnit.

" } }, "com.amazonaws.dlm#RetentionIntervalUnitValues": { @@ -1352,7 +1370,7 @@ "VariableTags": { "target": "com.amazonaws.dlm#VariableTagsList", "traits": { - "smithy.api#documentation": "

A collection of key/value pairs with values determined dynamically when the policy is\n\t\t\texecuted. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two\n\t\t\tfollowing formats: $(instance-id) or $(timestamp). Variable\n\t\t\ttags are only valid for EBS Snapshot Management – Instance policies.

" + "smithy.api#documentation": "

\n [AMI policies and snapshot policies that target instances only] \n\t\t\tA collection of key/value pairs with values determined dynamically when the policy is\n\t\t\texecuted. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two\n\t\t\tfollowing formats: $(instance-id) or $(timestamp). Variable\n\t\t\ttags are only valid for EBS Snapshot Management – Instance policies.

" } }, "CreateRule": { @@ -1364,36 +1382,36 @@ "RetainRule": { "target": "com.amazonaws.dlm#RetainRule", "traits": { - "smithy.api#documentation": "

The retention rule.

" + "smithy.api#documentation": "

The retention rule for snapshots or AMIs created by the policy.

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

The rule for enabling fast snapshot restore.

" + "smithy.api#documentation": "

\n [Snapshot policies only] The rule for enabling fast snapshot restore.

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

The rule for cross-Region snapshot copies.

\n\t\t

You can only specify cross-Region copy rules for policies that create snapshots in a Region. \n\t\t\tIf the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or \n\t\t\tto an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three \n\t\t\tRegions or Outposts.

" + "smithy.api#documentation": "

Specifies a rule for copying snapshots or AMIs across regions.

\n\t\t\n\t\t \n

You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. \n\t\t\tIf the policy creates snapshots in a Region, then snapshots can be copied to up to three \n\t\t\tRegions or Outposts.

\n " } }, "ShareRules": { "target": "com.amazonaws.dlm#ShareRules", "traits": { - "smithy.api#documentation": "

The rule for sharing snapshots with other Amazon Web Services accounts.

" + "smithy.api#documentation": "

\n [Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.

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

The AMI deprecation rule for the schedule.

" + "smithy.api#documentation": "

\n [AMI policies only] The AMI deprecation rule for the schedule.

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

Specifies a backup schedule for a snapshot or AMI lifecycle policy.

" + "smithy.api#documentation": "

\n [Snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.

" } }, "com.amazonaws.dlm#ScheduleList": { @@ -1457,7 +1475,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a rule for sharing snapshots across Amazon Web Services accounts.

" + "smithy.api#documentation": "

\n [Snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.

" } }, "com.amazonaws.dlm#ShareRules": { @@ -1878,6 +1896,21 @@ }, "com.amazonaws.dlm#dlm_20180112": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "DLM", + "arnNamespace": "dlm", + "cloudFormationName": "DLM", + "cloudTrailEventSource": "dlm.amazonaws.com", + "endpointPrefix": "dlm" + }, + "aws.auth#sigv4": { + "name": "dlm" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Data Lifecycle Manager\n\t\t

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create\n\t\t\tlifecycle policies, which are used to automate operations on the specified\n\t\t\tresources.

\n\t\t

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM\n\t\t\twith Amazon EBS, see Automating the Amazon EBS\n\t\t\t\tSnapshot Lifecycle in the Amazon EC2 User Guide.

", + "smithy.api#title": "Amazon Data Lifecycle Manager" + }, "version": "2018-01-12", "operations": [ { @@ -1904,22 +1937,7 @@ { "target": "com.amazonaws.dlm#UpdateLifecyclePolicy" } - ], - "traits": { - "aws.api#service": { - "sdkId": "DLM", - "arnNamespace": "dlm", - "cloudFormationName": "DLM", - "cloudTrailEventSource": "dlm.amazonaws.com", - "endpointPrefix": "dlm" - }, - "aws.auth#sigv4": { - "name": "dlm" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Data Lifecycle Manager\n\t\t

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create\n\t\t\tlifecycle policies, which are used to automate operations on the specified\n\t\t\tresources.

\n\t\t

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM\n\t\t\twith Amazon EBS, see Automating the Amazon EBS\n\t\t\t\tSnapshot Lifecycle in the Amazon EC2 User Guide.

", - "smithy.api#title": "Amazon Data Lifecycle Manager" - } + ] } } } diff --git a/codegen/sdk/aws-models/dynamodb.json b/codegen/sdk/aws-models/dynamodb.json index 79ea156ea9a..9cc85efde2c 100644 --- a/codegen/sdk/aws-models/dynamodb.json +++ b/codegen/sdk/aws-models/dynamodb.json @@ -897,7 +897,7 @@ "Message": { "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "

The error message associated with the PartiQL batch resposne.

" + "smithy.api#documentation": "

The error message associated with the PartiQL batch response.

" } } }, @@ -1248,7 +1248,19 @@ } }, "com.amazonaws.dynamodb#ClientToken": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\$]+$" + } + }, + "com.amazonaws.dynamodb#CloudWatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } }, "com.amazonaws.dynamodb#Code": { "type": "string" @@ -1954,6 +1966,58 @@ "smithy.api#documentation": "

Represents the output of a CreateTable operation.

" } }, + "com.amazonaws.dynamodb#CsvDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[,;:|\\t ]$" + } + }, + "com.amazonaws.dynamodb#CsvHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[\\x20-\\x21\\x23-\\x2B\\x2D-\\x7E]*$" + } + }, + "com.amazonaws.dynamodb#CsvHeaderList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#CsvHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#CsvOptions": { + "type": "structure", + "members": { + "Delimiter": { + "target": "com.amazonaws.dynamodb#CsvDelimiter", + "traits": { + "smithy.api#documentation": "

\n The delimiter used for separating items in the CSV file being imported.\n

" + } + }, + "HeaderList": { + "target": "com.amazonaws.dynamodb#CsvHeaderList", + "traits": { + "smithy.api#documentation": "

List of the headers used to specify a common header for all source CSV files being\n imported. If this field is specified then the first line of each CSV file is treated as\n data instead of the header. If this field is not specified the the first line of each\n CSV file is treated as the header. \n

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

\n Processing options for the CSV file being imported.\n

" + } + }, "com.amazonaws.dynamodb#Date": { "type": "timestamp" }, @@ -2668,6 +2732,47 @@ } } }, + "com.amazonaws.dynamodb#DescribeImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeImportInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeImportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ImportNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Represents the properties of the import.\n

" + } + }, + "com.amazonaws.dynamodb#DescribeImportInput": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the table you're importing to.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dynamodb#DescribeImportOutput": { + "type": "structure", + "members": { + "ImportTableDescription": { + "target": "com.amazonaws.dynamodb#ImportTableDescription", + "traits": { + "smithy.api#documentation": "

\n Represents the properties of the table created for the import, and parameters of \n the import. The import parameters include import status, how many items were processed, \n and how many errors were encountered.\n

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination": { "type": "operation", "input": { @@ -3117,6 +3222,9 @@ { "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettings" }, + { + "target": "com.amazonaws.dynamodb#DescribeImport" + }, { "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination" }, @@ -3150,6 +3258,9 @@ { "target": "com.amazonaws.dynamodb#GetItem" }, + { + "target": "com.amazonaws.dynamodb#ImportTable" + }, { "target": "com.amazonaws.dynamodb#ListBackups" }, @@ -3162,6 +3273,9 @@ { "target": "com.amazonaws.dynamodb#ListGlobalTables" }, + { + "target": "com.amazonaws.dynamodb#ListImports" + }, { "target": "com.amazonaws.dynamodb#ListTables" }, @@ -3281,6 +3395,14 @@ "target": "com.amazonaws.dynamodb#Endpoint" } }, + "com.amazonaws.dynamodb#ErrorCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.dynamodb#ErrorMessage": { "type": "string" }, @@ -3789,7 +3911,7 @@ "ClientToken": { "target": "com.amazonaws.dynamodb#ClientToken", "traits": { - "smithy.api#documentation": "

Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

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

Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n ImportConflictException.

", "smithy.api#idempotencyToken": {} } }, @@ -4412,6 +4534,354 @@ "smithy.api#error": "client" } }, + "com.amazonaws.dynamodb#ImportArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#ImportConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n There was a conflict when importing from the specified S3 source. \n This can occur when the current import conflicts with a previous import request \n that had the same client token.\n

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportEndTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ImportNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 112, + "max": 1024 + }, + "smithy.api#pattern": "^([0-9a-f]{16})+$" + } + }, + "com.amazonaws.dynamodb#ImportNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n The specified import was not found.\n

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportStartTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ImportStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "CANCELLING", + "name": "CANCELLING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.dynamodb#ImportSummary": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) corresponding to the import request.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.dynamodb#ImportStatus", + "traits": { + "smithy.api#documentation": "

\n The status of the import operation.\n

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the table being imported into.\n

" + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

\n The path and S3 bucket of the source file that is being imported. This includes the S3Bucket (required), \n S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is owned by the requester).\n

" + } + }, + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this import task.\n

" + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

\n The format of the source data. Valid values are CSV,\n DYNAMODB_JSON or ION.

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ImportStartTime", + "traits": { + "smithy.api#documentation": "

\n The time at which this import task began.\n

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ImportEndTime", + "traits": { + "smithy.api#documentation": "

\n The time at which this import task ended. (Does this include the successful complete creation of \n the table it was imported to?)\n

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

\n Summary information about the source file for the import.\n

" + } + }, + "com.amazonaws.dynamodb#ImportSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ImportSummary" + } + }, + "com.amazonaws.dynamodb#ImportTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ImportTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ImportTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ImportConflictException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Imports table data from an S3 bucket. \n \n

" + } + }, + "com.amazonaws.dynamodb#ImportTableDescription": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) corresponding to the import request.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.dynamodb#ImportStatus", + "traits": { + "smithy.api#documentation": "

\n The status of the import.\n

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the table being imported into.\n

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

\n The table id corresponding to the table created by import table process.\n \n

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

\n The client token that was provided for the import task. Reusing the client token \n on retry makes a call to ImportTable idempotent.\n

" + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

\n Values for the S3 bucket the source file is imported from. Includes bucket name (required), \n key prefix (optional) and bucket account owner ID (optional).\n

" + } + }, + "ErrorCount": { + "target": "com.amazonaws.dynamodb#ErrorCount", + "traits": { + "smithy.api#documentation": "

\n The number of errors occurred on importing the source file into the target table.\n

" + } + }, + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.\n

" + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

\n The format of the source data going into the target table.\n

" + } + }, + "InputFormatOptions": { + "target": "com.amazonaws.dynamodb#InputFormatOptions", + "traits": { + "smithy.api#documentation": "

The format options for the data that was imported into the target table. There is one value, CsvOption.\n

" + } + }, + "InputCompressionType": { + "target": "com.amazonaws.dynamodb#InputCompressionType", + "traits": { + "smithy.api#documentation": "

\n The compression options for the data that has been imported into the target table. The values are \n NONE, GZIP, or ZSTD.\n

" + } + }, + "TableCreationParameters": { + "target": "com.amazonaws.dynamodb#TableCreationParameters", + "traits": { + "smithy.api#documentation": "

\n The parameters for the new table that is being imported into.\n

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ImportStartTime", + "traits": { + "smithy.api#documentation": "

\n The time when this import task started.\n

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ImportEndTime", + "traits": { + "smithy.api#documentation": "

\n The time at which the creation of the table associated with this import task completed.\n

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

\n The total size of data processed from the source file, in Bytes.\n

" + } + }, + "ProcessedItemCount": { + "target": "com.amazonaws.dynamodb#ProcessedItemCount", + "traits": { + "smithy.api#documentation": "

\n The total number of items processed from the source file.\n

" + } + }, + "ImportedItemCount": { + "target": "com.amazonaws.dynamodb#ImportedItemCount", + "traits": { + "smithy.api#documentation": "

\n The number of items successfully imported into the new table.\n

" + } + }, + "FailureCode": { + "target": "com.amazonaws.dynamodb#FailureCode", + "traits": { + "smithy.api#documentation": "

\n The error code corresponding to the failure that the import job ran into during execution.\n

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.dynamodb#FailureMessage", + "traits": { + "smithy.api#documentation": "

\n The error message corresponding to the failure that the import job ran into during execution.\n

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

\n Represents the properties of the table being imported into.\n

" + } + }, + "com.amazonaws.dynamodb#ImportTableInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

Providing a ClientToken makes the call to\n ImportTableInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

", + "smithy.api#idempotencyToken": {} + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

\n The S3 bucket that provides the source for the import.\n

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

The format of the source data. Valid values for ImportFormat are\n CSV, DYNAMODB_JSON or ION.\n

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

\n Additional properties that specify how the input is formatted,\n

" + } + }, + "InputCompressionType": { + "target": "com.amazonaws.dynamodb#InputCompressionType", + "traits": { + "smithy.api#documentation": "

\n Type of compression to be used on the input coming from the imported table.\n

" + } + }, + "TableCreationParameters": { + "target": "com.amazonaws.dynamodb#TableCreationParameters", + "traits": { + "smithy.api#documentation": "

Parameters for the table to import the data into.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dynamodb#ImportTableOutput": { + "type": "structure", + "members": { + "ImportTableDescription": { + "target": "com.amazonaws.dynamodb#ImportTableDescription", + "traits": { + "smithy.api#documentation": "

\n Represents the properties of the table created for the import, and parameters of \n the import. The import parameters include import status, how many items were processed, \n and how many errors were encountered.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dynamodb#ImportedItemCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.dynamodb#IndexName": { "type": "string", "traits": { @@ -4457,6 +4927,58 @@ ] } }, + "com.amazonaws.dynamodb#InputCompressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GZIP", + "name": "GZIP" + }, + { + "value": "ZSTD", + "name": "ZSTD" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.dynamodb#InputFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DYNAMODB_JSON", + "name": "DYNAMODB_JSON" + }, + { + "value": "ION", + "name": "ION" + }, + { + "value": "CSV", + "name": "CSV" + } + ] + } + }, + "com.amazonaws.dynamodb#InputFormatOptions": { + "type": "structure", + "members": { + "Csv": { + "target": "com.amazonaws.dynamodb#CsvOptions", + "traits": { + "smithy.api#documentation": "

\n The options for imported source files in CSV format. The values are Delimiter and HeaderList.\n

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

\n The format options for the data that was imported into the target table. There is one value, CsvOption.

" + } + }, "com.amazonaws.dynamodb#Integer": { "type": "integer" }, @@ -5155,6 +5677,78 @@ } } }, + "com.amazonaws.dynamodb#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListImportsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListImportsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists completed imports within the past 90 days.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.dynamodb#ListImportsInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the table that was imported to.\n

" + } + }, + "PageSize": { + "target": "com.amazonaws.dynamodb#ListImportsMaxLimit", + "traits": { + "smithy.api#documentation": "

\n The number of ImportSummary objects returned in a single page.\n

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

\n An optional string that, if supplied, must be copied from the output of a previous\n call to ListImports. When provided in this manner, the API fetches the next\n page of results.\n

" + } + } + } + }, + "com.amazonaws.dynamodb#ListImportsMaxLimit": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#ListImportsOutput": { + "type": "structure", + "members": { + "ImportSummaryList": { + "target": "com.amazonaws.dynamodb#ImportSummaryList", + "traits": { + "smithy.api#documentation": "

\n A list of ImportSummary objects.\n

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

\n If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListImports again, with NextToken set to this\n value.\n

" + } + } + } + }, "com.amazonaws.dynamodb#ListTables": { "type": "operation", "input": { @@ -5638,6 +6232,14 @@ } } }, + "com.amazonaws.dynamodb#ProcessedItemCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.dynamodb#Projection": { "type": "structure", "members": { @@ -7154,13 +7756,56 @@ } }, "com.amazonaws.dynamodb#S3Bucket": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[a-z0-9A-Z]+[\\.\\-\\w]*[a-z0-9A-Z]+$" + } }, "com.amazonaws.dynamodb#S3BucketOwner": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.dynamodb#S3BucketSource": { + "type": "structure", + "members": { + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

\n The account number of the S3 bucket that is being imported from. \n If the bucket is owned by the requester this is optional. \n

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.dynamodb#S3Bucket", + "traits": { + "smithy.api#documentation": "

\n The S3 bucket that is being imported from.\n

", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "

\n The key prefix shared by all S3 Objects that are being imported.\n

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

\n The S3 bucket that is being imported from.\n

" + } }, "com.amazonaws.dynamodb#S3Prefix": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } }, "com.amazonaws.dynamodb#S3SseAlgorithm": { "type": "string", @@ -7799,6 +8444,53 @@ "com.amazonaws.dynamodb#TableCreationDateTime": { "type": "timestamp" }, + "com.amazonaws.dynamodb#TableCreationParameters": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

\n The name of the table created as part of the import operation. \n

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

\n The attributes of the table created as part of the import operation.\n

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

\n The primary key and option sort key of the table created as part of the import operation.\n

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

\n The billing mode for provisioning the table created as part of the import operation.\n

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput" + }, + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification" + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

\n The Global Secondary Indexes (GSI) of the table to be created as part of the import operation.\n

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

The parameters for the table created as part of the import operation.\n

" + } + }, "com.amazonaws.dynamodb#TableDescription": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index ec1b6a88772..30b8a09a013 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -9136,6 +9136,67 @@ } } }, + "com.amazonaws.ec2#CloudWatchLogGroupArn": { + "type": "string" + }, + "com.amazonaws.ec2#CloudWatchLogOptions": { + "type": "structure", + "members": { + "LogEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "LogEnabled", + "smithy.api#documentation": "

Status of VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

", + "smithy.api#xmlName": "logEnabled" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogGroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

", + "smithy.api#xmlName": "logGroupArn" + } + }, + "LogOutputFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogOutputFormat", + "smithy.api#documentation": "

Configured log format. Default format is json.

\n

Valid values: json | text\n

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

Options for sending VPN tunnel logs to CloudWatch.

" + } + }, + "com.amazonaws.ec2#CloudWatchLogOptionsSpecification": { + "type": "structure", + "members": { + "LogEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enable or disable VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.ec2#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

" + } + }, + "LogOutputFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Set log format. Default format is json.

\n\t

Valid values: json | text\n

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

Options for sending VPN tunnel logs to CloudWatch.

" + } + }, "com.amazonaws.ec2#CoipAddressUsage": { "type": "structure", "members": { @@ -45865,6 +45926,12 @@ "traits": { "smithy.api#documentation": "

Excludes the root volume from being snapshotted.

" } + }, + "ExcludeDataVolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#xmlName": "ExcludeDataVolumeId" + } } }, "traits": { @@ -58179,6 +58246,12 @@ "traits": { "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } } }, "traits": { @@ -78368,6 +78441,14 @@ "smithy.api#documentation": "

The action to take when the establishing the VPN tunnels for a VPN connection.

", "smithy.api#xmlName": "startupAction" } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptions", + "traits": { + "aws.protocols#ec2QueryName": "LogOptions", + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

", + "smithy.api#xmlName": "logOptions" + } } }, "traits": { @@ -81626,6 +81707,36 @@ ] } }, + "com.amazonaws.ec2#VpnTunnelLogOptions": { + "type": "structure", + "members": { + "CloudWatchLogOptions": { + "target": "com.amazonaws.ec2#CloudWatchLogOptions", + "traits": { + "aws.protocols#ec2QueryName": "CloudWatchLogOptions", + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

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

Options for logging VPN tunnel activity.

" + } + }, + "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification": { + "type": "structure", + "members": { + "CloudWatchLogOptions": { + "target": "com.amazonaws.ec2#CloudWatchLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

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

Options for logging VPN tunnel activity.

" + } + }, "com.amazonaws.ec2#VpnTunnelOptionsSpecification": { "type": "structure", "members": { @@ -81743,6 +81854,12 @@ "traits": { "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index dad3c6851a2..3e4d26a63a0 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -4535,6 +4535,10 @@ { "value": "FAILED", "name": "FAILED" + }, + { + "value": "ERROR", + "name": "ERROR" } ] } @@ -5974,6 +5978,12 @@ "traits": { "smithy.api#documentation": "

The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

" } + }, + "ExecutionClass": { + "target": "com.amazonaws.glue#ExecutionClass", + "traits": { + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + } } } }, @@ -9833,6 +9843,25 @@ "com.amazonaws.glue#EventQueueArn": { "type": "string" }, + "com.amazonaws.glue#ExecutionClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FLEX", + "name": "FLEX" + }, + { + "value": "STANDARD", + "name": "STANDARD" + } + ], + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, "com.amazonaws.glue#ExecutionProperty": { "type": "structure", "members": { @@ -15779,6 +15808,12 @@ "traits": { "smithy.api#documentation": "

The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

" } + }, + "ExecutionClass": { + "target": "com.amazonaws.glue#ExecutionClass", + "traits": { + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

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

This field populates only for Auto Scaling job runs, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X, 2 for G.2X, or 0.25 for G.025X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity. Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity.

" } + }, + "ExecutionClass": { + "target": "com.amazonaws.glue#ExecutionClass", + "traits": { + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + } } }, "traits": { @@ -16111,6 +16152,14 @@ { "value": "TIMEOUT", "name": "TIMEOUT" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "WAITING", + "name": "WAITING" } ] } @@ -16228,6 +16277,12 @@ "traits": { "smithy.api#documentation": "

The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

" } + }, + "ExecutionClass": { + "target": "com.amazonaws.glue#ExecutionClass", + "traits": { + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + } } }, "traits": { @@ -20147,7 +20202,7 @@ "com.amazonaws.glue#PythonVersionString": { "type": "string", "traits": { - "smithy.api#pattern": "^[2-3]$" + "smithy.api#pattern": "^([2-3]|3[.]9)$" } }, "com.amazonaws.glue#QuerySchemaVersionMetadata": { @@ -23265,6 +23320,12 @@ "traits": { "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a job runs.

" } + }, + "ExecutionClass": { + "target": "com.amazonaws.glue#ExecutionClass", + "traits": { + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + } } } }, @@ -27363,6 +27424,18 @@ "traits": { "smithy.api#documentation": "

Total number Actions in running state.

" } + }, + "ErroredActions": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "

Indicates the count of job runs in the ERROR state in the workflow run.

" + } + }, + "WaitingActions": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "

Indicates the count of job runs in WAITING state in the workflow run.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/identitystore.json b/codegen/sdk/aws-models/identitystore.json index d7ffa7e6a52..244bc513980 100644 --- a/codegen/sdk/aws-models/identitystore.json +++ b/codegen/sdk/aws-models/identitystore.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.identitystore#AWSIdentityStore": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "identitystore", + "arnNamespace": "identitystore", + "cloudFormationName": "Identitystore", + "cloudTrailEventSource": "identitystore.amazonaws.com", + "endpointPrefix": "identitystore" + }, + "aws.auth#sigv4": { + "name": "identitystore" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

The Identity Store service used by Amazon Web Services Single Sign On provides a single place to retrieve all of\n your identities (users and groups). For more information, see the Amazon Web Services SSO User\n Guide.

\n \n \n

Although Amazon Web Services 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 Amazon Web Services SSO rename.

\n \n \n

This reference guide describes the identity store operations that you can call\n programatically and includes detailed information on data types and errors.

", + "smithy.api#title": "AWS SSO Identity Store" + }, "version": "2020-06-15", "operations": [ { @@ -45,22 +60,7 @@ { "target": "com.amazonaws.identitystore#ListUsers" } - ], - "traits": { - "aws.api#service": { - "sdkId": "identitystore", - "arnNamespace": "identitystore", - "cloudFormationName": "Identitystore", - "cloudTrailEventSource": "identitystore.amazonaws.com", - "endpointPrefix": "identitystore" - }, - "aws.auth#sigv4": { - "name": "identitystore" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your\n identities (users and groups). For more information about AWS, see the AWS Single Sign-On User\n Guide.

", - "smithy.api#title": "AWS SSO Identity Store" - } + ] }, "com.amazonaws.identitystore#AccessDeniedException": { "type": "structure", @@ -71,7 +71,7 @@ "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { - "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by\n the identity store service for each sent request, and is then returned inside the exception\n if the request fails.

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

Retrieves the group metadata and attributes from GroupId in an identity store.

" + "smithy.api#documentation": "

Retrieves the group metadata and attributes from GroupId in an identity\n store.

" } }, "com.amazonaws.identitystore#DescribeGroupRequest": { @@ -184,7 +184,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the user metadata and attributes from UserId in an identity store.

" + "smithy.api#documentation": "

Retrieves the user metadata and attributes from UserId in an identity\n store.

" } }, "com.amazonaws.identitystore#DescribeUserRequest": { @@ -238,13 +238,13 @@ "AttributeValue": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { - "smithy.api#documentation": "

Represents the data for an attribute. Each attribute value is described as a name-value pair.

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

Represents the data for an attribute. Each attribute value is described as a name-value\n pair.

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

A query filter used by ListUsers and ListGroup. This filter object provides the attribute name and attribute value to\n search users or groups.

" + "smithy.api#documentation": "

A query filter used by ListUsers and ListGroups. This filter\n object provides the attribute name and attribute value to search users or groups.

" } }, "com.amazonaws.identitystore#Filters": { @@ -266,7 +266,7 @@ "DisplayName": { "target": "com.amazonaws.identitystore#GroupDisplayName", "traits": { - "smithy.api#documentation": "

Contains the group’s display name value. The length limit is 1,024 characters. This\n value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n line, carriage return, space, and nonbreaking space in this attribute. The characters\n <>;:% are excluded. This value is specified at the time the group\n is created and stored as an attribute of the group object in the identity store.

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

Contains the group’s display name value. The length limit is 1,024 characters. This\n value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n line, carriage return, space, and nonbreaking space in this attribute. The characters\n <>;:% are excluded. This value is specified at the time the group is\n created and stored as an attribute of the group object in the identity store.

", "smithy.api#required": {} } } @@ -310,12 +310,12 @@ "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { - "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by\n the identity store service for each sent request, and is then returned inside the exception\n if the request fails.

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

The request processing has failed because of an unknown error, exception or failure with an internal server.

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

The request processing has failed because of an unknown error, exception or failure with\n an internal server.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -346,7 +346,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter\n attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group\n DisplayName in the response.

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

Lists the attribute name and value of the group that you specified in the search. We\n only support DisplayName as a valid filter attribute path currently, and\n filter is required. This API returns minimum attributes, including GroupId and\n group DisplayName in the response.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -379,7 +379,7 @@ "Filters": { "target": "com.amazonaws.identitystore#Filters", "traits": { - "smithy.api#documentation": "

A list of Filter objects, which is used in the ListUsers and ListGroups request.

" + "smithy.api#documentation": "

A list of Filter objects, which is used in the ListUsers and\n ListGroups request.

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

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute\n path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the\n response.

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

Lists the attribute name and value of the user that you specified in the search. We only\n support UserName as a valid filter attribute path currently, and filter is\n required. This API returns minimum attributes, including UserId and\n UserName in the response.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -461,7 +461,7 @@ "Filters": { "target": "com.amazonaws.identitystore#Filters", "traits": { - "smithy.api#documentation": "

A list of Filter objects, which is used in the ListUsers and ListGroups request.

" + "smithy.api#documentation": "

A list of Filter objects, which is used in the ListUsers and\n ListGroups request.

" } } } @@ -535,13 +535,13 @@ "ResourceType": { "target": "com.amazonaws.identitystore#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource in the Identity Store service, which is an enum object. Valid values include USER, GROUP, and IDENTITY_STORE.

" + "smithy.api#documentation": "

The type of resource in the identity store service, which is an enum object. Valid\n values include USER, GROUP, and IDENTITY_STORE.

" } }, "ResourceId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { - "smithy.api#documentation": "

The identifier for a resource in the identity store, which can be used as UserId or GroupId. The format for ResourceId is either UUID or 1234567890-UUID, where UUID is a randomly generated value for each resource when it is created and 1234567890 represents the IdentityStoreId string value. In the case that the identity store is migrated from a legacy SSO identity store, the ResourceId for that identity store will be in the format of UUID. Otherwise, it will be in the 1234567890-UUID format.

" + "smithy.api#documentation": "

The identifier for a resource in the identity store, which can be used as\n UserId or GroupId. The format for ResourceId is\n either UUID or 1234567890-UUID, where UUID is a\n randomly generated value for each resource when it is created and 1234567890\n represents the IdentityStoreId string value. In the case that the identity\n store is migrated from a legacy single sign-on identity store, the ResourceId for that\n identity store will be in the format of UUID. Otherwise, it will be in the\n 1234567890-UUID format.

" } }, "Message": { @@ -550,7 +550,7 @@ "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { - "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by\n the identity store service for each sent request, and is then returned inside the exception\n if the request fails.

" } } }, @@ -599,12 +599,12 @@ "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { - "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by\n the identity store service for each sent request, and is then returned inside the exception\n if the request fails.

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

Indicates that the principal has crossed the throttling limits of the API operations.

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

Indicates that the principal has crossed the throttling limits of the API\n operations.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -657,7 +657,7 @@ "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { - "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by\n the identity store service for each sent request, and is then returned inside the exception\n if the request fails.

" } } }, diff --git a/codegen/sdk/aws-models/iot-wireless.json b/codegen/sdk/aws-models/iot-wireless.json index 3880872550b..6b438666c06 100644 --- a/codegen/sdk/aws-models/iot-wireless.json +++ b/codegen/sdk/aws-models/iot-wireless.json @@ -117,6 +117,16 @@ "smithy.api#documentation": "

The accuracy of the estimated position in meters. An empty value indicates that no position data is available. \n A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information\n that you specified instead of the position computed by solver.

" } }, + "com.amazonaws.iotwireless#AckModeRetryDurationSecs": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 604800 + } + } + }, "com.amazonaws.iotwireless#AddGwMetadata": { "type": "boolean" }, @@ -3050,6 +3060,16 @@ } } }, + "com.amazonaws.iotwireless#DrMaxBox": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, "com.amazonaws.iotwireless#DrMin": { "type": "integer", "traits": { @@ -3059,6 +3079,16 @@ } } }, + "com.amazonaws.iotwireless#DrMinBox": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, "com.amazonaws.iotwireless#EndPoint": { "type": "string", "traits": { @@ -3157,6 +3187,12 @@ "traits": { "smithy.api#documentation": "

Connection status event configuration for an event configuration item.

" } + }, + "MessageDeliveryStatus": { + "target": "com.amazonaws.iotwireless#MessageDeliveryStatusEventConfiguration", + "traits": { + "smithy.api#documentation": "

Message delivery status event configuration for an event configuration item.

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

Resource type event configuration for the connection status event.

" } + }, + "MessageDeliveryStatus": { + "target": "com.amazonaws.iotwireless#MessageDeliveryStatusResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Resource type event configuration object for the message delivery status event.

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

Event configuration for the connection status event.

" } + }, + "MessageDeliveryStatus": { + "target": "com.amazonaws.iotwireless#MessageDeliveryStatusEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the message delivery status event.

" + } } } }, @@ -7108,6 +7156,18 @@ "traits": { "smithy.api#documentation": "

The AddGWMetaData value.

" } + }, + "DrMin": { + "target": "com.amazonaws.iotwireless#DrMinBox", + "traits": { + "smithy.api#documentation": "

The DrMin value.

" + } + }, + "DrMax": { + "target": "com.amazonaws.iotwireless#DrMaxBox", + "traits": { + "smithy.api#documentation": "

The DrMax value.

" + } } }, "traits": { @@ -7294,6 +7354,34 @@ } } }, + "com.amazonaws.iotwireless#MessageDeliveryStatusEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations" + }, + "WirelessDeviceIdEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless device id device registration state event topic is enabled\n or disabled.

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

Message delivery status event configuration object for enabling and disabling relevant\n topics.

" + } + }, + "com.amazonaws.iotwireless#MessageDeliveryStatusResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Message delivery status resource type event configuration object for enabling or disabling\n relevant topic.

" + } + }, "com.amazonaws.iotwireless#MessageId": { "type": "string" }, @@ -8822,6 +8910,12 @@ }, "MessageType": { "target": "com.amazonaws.iotwireless#MessageType" + }, + "AckModeRetryDurationSecs": { + "target": "com.amazonaws.iotwireless#AckModeRetryDurationSecs", + "traits": { + "smithy.api#documentation": "

The duration of time in seconds for which you want to retry sending the ACK.

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

Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

" } + }, + "MessageDeliveryStatus": { + "target": "com.amazonaws.iotwireless#MessageDeliveryStatusResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Message delivery status resource type event configuration object for enabling and disabling wireless device topic.

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

Event configuration for the connection status event.

" } + }, + "MessageDeliveryStatus": { + "target": "com.amazonaws.iotwireless#MessageDeliveryStatusEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the message delivery status event.

" + } } } }, diff --git a/codegen/sdk/aws-models/iot.json b/codegen/sdk/aws-models/iot.json index c5f20e60fb5..5f732b495b9 100644 --- a/codegen/sdk/aws-models/iot.json +++ b/codegen/sdk/aws-models/iot.json @@ -6675,7 +6675,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a fleet provisioning template.

\n

Requires permission to access the CreateProvisioningTemplate action.

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

Creates a provisioning template.

\n

Requires permission to access the CreateProvisioningTemplate action.

", "smithy.api#http": { "method": "POST", "uri": "/provisioning-templates", @@ -6689,33 +6689,33 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

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

The name of the provisioning template.

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

The description of the fleet provisioning template.

" + "smithy.api#documentation": "

The description of the provisioning template.

" } }, "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { - "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

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

The JSON formatted contents of the provisioning template.

", "smithy.api#required": {} } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { - "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" + "smithy.api#documentation": "

True to enable the provisioning template, otherwise false.

" } }, "provisioningRoleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The role ARN for the role associated with the fleet provisioning template. This IoT role\n grants permission to provision a device.

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

The role ARN for the role associated with the provisioning template. This IoT role\n grants permission to provision a device.

", "smithy.api#required": {} } }, @@ -6728,7 +6728,13 @@ "tags": { "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the fleet provisioning template.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

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

Metadata which can be used to manage the provisioning template.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " + } + }, + "type": { + "target": "com.amazonaws.iot#TemplateType", + "traits": { + "smithy.api#documentation": "

The type you define in a provisioning template. You can create a template with only one type.\n You can't change the template type after its creation. The default value is FLEET_PROVISIONING.\n For more information about provisioning template, see: Provisioning template.\n

" } } } @@ -6745,13 +6751,13 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

" + "smithy.api#documentation": "

The name of the provisioning template.

" } }, "defaultVersionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { - "smithy.api#documentation": "

The default version of the fleet provisioning template.

" + "smithy.api#documentation": "

The default version of the provisioning template.

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

Creates a new version of a fleet provisioning template.

\n

Requires permission to access the CreateProvisioningTemplateVersion action.

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

Creates a new version of a provisioning template.

\n

Requires permission to access the CreateProvisioningTemplateVersion action.

", "smithy.api#http": { "method": "POST", "uri": "/provisioning-templates/{templateName}/versions", @@ -6802,7 +6808,7 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

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

The name of the provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6810,7 +6816,7 @@ "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { - "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

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

The JSON formatted contents of the provisioning template.

", "smithy.api#required": {} } }, @@ -6835,19 +6841,19 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

" + "smithy.api#documentation": "

The name of the provisioning template.

" } }, "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { - "smithy.api#documentation": "

The version of the fleet provisioning template.

" + "smithy.api#documentation": "

The version of the provisioning template.

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

True if the fleet provisioning template version is the default version, otherwise\n false.

" + "smithy.api#documentation": "

True if the provisioning template version is the default version, otherwise\n false.

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

Deletes a fleet provisioning template.

\n

Requires permission to access the DeleteProvisioningTemplate action.

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

Deletes a provisioning template.

\n

Requires permission to access the DeleteProvisioningTemplate action.

", "smithy.api#http": { "method": "DELETE", "uri": "/provisioning-templates/{templateName}", @@ -8918,7 +8924,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a fleet provisioning template version.

\n

Requires permission to access the DeleteProvisioningTemplateVersion action.

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

Deletes a provisioning template version.

\n

Requires permission to access the DeleteProvisioningTemplateVersion action.

", "smithy.api#http": { "method": "DELETE", "uri": "/provisioning-templates/{templateName}/versions/{versionId}", @@ -8932,7 +8938,7 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template version to delete.

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

The name of the provisioning template version to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8940,7 +8946,7 @@ "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { - "smithy.api#documentation": "

The fleet provisioning template version ID to delete.

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

The provisioning template version ID to delete.

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

Returns information about a fleet provisioning template.

\n

Requires permission to access the DescribeProvisioningTemplate action.

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

Returns information about a provisioning template.

\n

Requires permission to access the DescribeProvisioningTemplate action.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates/{templateName}", @@ -11465,7 +11471,7 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

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

The name of the provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11478,31 +11484,31 @@ "templateArn": { "target": "com.amazonaws.iot#TemplateArn", "traits": { - "smithy.api#documentation": "

The ARN of the fleet provisioning template.

" + "smithy.api#documentation": "

The ARN of the provisioning template.

" } }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

" + "smithy.api#documentation": "

The name of the provisioning template.

" } }, "description": { "target": "com.amazonaws.iot#TemplateDescription", "traits": { - "smithy.api#documentation": "

The description of the fleet provisioning template.

" + "smithy.api#documentation": "

The description of the provisioning template.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template was created.

" + "smithy.api#documentation": "

The date when the provisioning template was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template was last modified.

" + "smithy.api#documentation": "

The date when the provisioning template was last modified.

" } }, "defaultVersionId": { @@ -11514,13 +11520,13 @@ "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { - "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

" + "smithy.api#documentation": "

The JSON formatted contents of the provisioning template.

" } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { - "smithy.api#documentation": "

True if the fleet provisioning template is enabled, otherwise false.

" + "smithy.api#documentation": "

True if the provisioning template is enabled, otherwise false.

" } }, "provisioningRoleArn": { @@ -11534,6 +11540,12 @@ "traits": { "smithy.api#documentation": "

Gets information about a pre-provisioned hook.

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

The type you define in a provisioning template. You can create a template with only one type.\n You can't change the template type after its creation. The default value is FLEET_PROVISIONING.\n For more information about provisioning template, see: Provisioning template.\n

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

Returns information about a fleet provisioning template version.

\n

Requires permission to access the DescribeProvisioningTemplateVersion action.

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

Returns information about a provisioning template version.

\n

Requires permission to access the DescribeProvisioningTemplateVersion action.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates/{templateName}/versions/{versionId}", @@ -11585,7 +11597,7 @@ "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { - "smithy.api#documentation": "

The fleet provisioning template version ID.

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

The provisioning template version ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11598,25 +11610,25 @@ "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { - "smithy.api#documentation": "

The fleet provisioning template version ID.

" + "smithy.api#documentation": "

The provisioning template version ID.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template version was created.

" + "smithy.api#documentation": "

The date when the provisioning template version was created.

" } }, "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { - "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template version.

" + "smithy.api#documentation": "

The JSON formatted contents of the provisioning template version.

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

True if the fleet provisioning template version is the default version.

" + "smithy.api#documentation": "

True if the provisioning template version is the default version.

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

Removes the specified policy from the specified certificate.

\n \n

This action is deprecated. Please use DetachPolicy instead.

\n \n

Requires permission to access the DetachPrincipalPolicy action.

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

Removes the specified policy from the specified certificate.

\n

\n Note: This action is deprecated and works as\n expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.

\n

Requires permission to access the DetachPrincipalPolicy action.

", "smithy.api#http": { "method": "DELETE", "uri": "/principal-policies/{policyName}", @@ -17640,6 +17652,13 @@ "smithy.api#documentation": "

Determines the order of the results.

", "smithy.api#httpQuery": "isAscendingOrder" } + }, + "templateName": { + "target": "com.amazonaws.iot#TemplateName", + "traits": { + "smithy.api#documentation": "

The name of the provisioning template.

", + "smithy.api#httpQuery": "templateName" + } } }, "traits": { @@ -19347,7 +19366,7 @@ ], "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Lists the principals associated with the specified policy.

\n

\n Note: This action is deprecated. Please use ListTargetsForPolicy instead.

\n

Requires permission to access the ListPolicyPrincipals action.

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

Lists the principals associated with the specified policy.

\n

\n Note: This action is deprecated and works as\n expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.

\n

Requires permission to access the ListPolicyPrincipals action.

", "smithy.api#http": { "method": "GET", "uri": "/policy-principals", @@ -19515,7 +19534,7 @@ ], "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Lists the policies attached to the specified principal. If you use an Cognito\n identity, the ID must be in AmazonCognito Identity format.

\n

\n Note: This action is deprecated. Please use ListAttachedPolicies instead.

\n

Requires permission to access the ListPrincipalPolicies action.

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

Lists the policies attached to the specified principal. If you use an Cognito\n identity, the ID must be in AmazonCognito Identity format.

\n

\n Note: This action is deprecated and works as\n expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

\n

Requires permission to access the ListPrincipalPolicies action.

", "smithy.api#http": { "method": "GET", "uri": "/principal-policies", @@ -19705,7 +19724,7 @@ } ], "traits": { - "smithy.api#documentation": "

A list of fleet provisioning template versions.

\n

Requires permission to access the ListProvisioningTemplateVersions action.

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

A list of provisioning template versions.

\n

Requires permission to access the ListProvisioningTemplateVersions action.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates/{templateName}/versions", @@ -19725,7 +19744,7 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

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

The name of the provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -19752,7 +19771,7 @@ "versions": { "target": "com.amazonaws.iot#ProvisioningTemplateVersionListing", "traits": { - "smithy.api#documentation": "

The list of fleet provisioning template versions.

" + "smithy.api#documentation": "

The list of provisioning template versions.

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

Lists the fleet provisioning templates in your Amazon Web Services account.

\n

Requires permission to access the ListProvisioningTemplates action.

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

Lists the provisioning templates in your Amazon Web Services account.

\n

Requires permission to access the ListProvisioningTemplates action.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates", @@ -19825,7 +19844,7 @@ "templates": { "target": "com.amazonaws.iot#ProvisioningTemplateListing", "traits": { - "smithy.api#documentation": "

A list of fleet provisioning templates

" + "smithy.api#documentation": "

A list of provisioning templates

" } }, "nextToken": { @@ -23269,31 +23288,31 @@ "templateArn": { "target": "com.amazonaws.iot#TemplateArn", "traits": { - "smithy.api#documentation": "

The ARN of the fleet provisioning template.

" + "smithy.api#documentation": "

The ARN of the provisioning template.

" } }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

" + "smithy.api#documentation": "

The name of the provisioning template.

" } }, "description": { "target": "com.amazonaws.iot#TemplateDescription", "traits": { - "smithy.api#documentation": "

The description of the fleet provisioning template.

" + "smithy.api#documentation": "

The description of the provisioning template.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template summary was created.

" + "smithy.api#documentation": "

The date when the provisioning template summary was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template summary was last modified.

" + "smithy.api#documentation": "

The date when the provisioning template summary was last modified.

" } }, "enabled": { @@ -23301,10 +23320,16 @@ "traits": { "smithy.api#documentation": "

True if the fleet provision template is enabled, otherwise false.

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

The type you define in a provisioning template. You can create a template with only one type.\n You can't change the template type after its creation. The default value is FLEET_PROVISIONING.\n For more information about provisioning template, see: Provisioning template.\n

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

A summary of information about a fleet provisioning template.

" + "smithy.api#documentation": "

A summary of information about a provisioning template.

" } }, "com.amazonaws.iot#ProvisioningTemplateVersionListing": { @@ -23325,13 +23350,13 @@ "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template version was created

" + "smithy.api#documentation": "

The date when the provisioning template version was created

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

True if the fleet provisioning template version is the default version, otherwise\n false.

" + "smithy.api#documentation": "

True if the provisioning template version is the default version, otherwise\n false.

" } } }, @@ -23627,6 +23652,9 @@ { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, @@ -24013,6 +24041,12 @@ "traits": { "smithy.api#documentation": "

The ARN of the role.

" } + }, + "templateName": { + "target": "com.amazonaws.iot#TemplateName", + "traits": { + "smithy.api#documentation": "

The name of the provisioning template.

" + } } }, "traits": { @@ -26885,6 +26919,21 @@ "smithy.api#pattern": "^[0-9A-Za-z_-]+$" } }, + "com.amazonaws.iot#TemplateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FLEET_PROVISIONING", + "name": "FLEET_PROVISIONING" + }, + { + "value": "JITP", + "name": "JITP" + } + ] + } + }, "com.amazonaws.iot#TemplateVersionId": { "type": "integer", "traits": { @@ -29686,7 +29735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a fleet provisioning template.

\n

Requires permission to access the UpdateProvisioningTemplate action.

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

Updates a provisioning template.

\n

Requires permission to access the UpdateProvisioningTemplate action.

", "smithy.api#http": { "method": "PATCH", "uri": "/provisioning-templates/{templateName}", @@ -29700,7 +29749,7 @@ "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

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

The name of the provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29708,13 +29757,13 @@ "description": { "target": "com.amazonaws.iot#TemplateDescription", "traits": { - "smithy.api#documentation": "

The description of the fleet provisioning template.

" + "smithy.api#documentation": "

The description of the provisioning template.

" } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { - "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" + "smithy.api#documentation": "

True to enable the provisioning template, otherwise false.

" } }, "defaultVersionId": { diff --git a/codegen/sdk/aws-models/ivs.json b/codegen/sdk/aws-models/ivs.json index b537481d645..a900dcd77a9 100644 --- a/codegen/sdk/aws-models/ivs.json +++ b/codegen/sdk/aws-models/ivs.json @@ -24,8 +24,7 @@ "sdkId": "ivs", "arnNamespace": "ivs", "cloudFormationName": "IVS", - "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE", - "endpointPrefix": "ivs" + "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE" }, "aws.auth#sigv4": { "name": "ivs" @@ -33,23 +32,24 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ - "amz-sdk-invocation-id", - "amz-sdk-request", - "X-Amz-Content-Sha256", - "X-Api-Key", "Content-Type", - "X-Amz-User-Agent" + "X-Api-Key", + "X-Amz-Content-Sha256", + "X-Amz-User-Agent", + "amz-sdk-invocation-id", + "amz-sdk-request" ], "additionalExposedHeaders": [ - "date", - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", "x-amzn-requestid", - "x-amzn-errormessage" + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amzn-requestid", + "x-amz-apigw-id", + "date" ] }, - "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.

\n

The API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n

For a summary of notable documentation changes in each release, see Document\n History.

\n

\n Allowed Header Values\n

\n \n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags.

\n

Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).

\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.

\n

At most 50 tags can be applied to a resource.

\n

\n Authentication versus Authorization\n

\n

Note the differences between these concepts:

\n \n

\n Authentication\n

\n

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.

\n

You generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from an IAM user account that has the ivs:PutMetadata\n permission.

\n

For more information:

\n \n

\n Channel Endpoints\n

\n \n

\n StreamKey Endpoints\n

\n \n

\n Stream Endpoints\n

\n \n

\n PlaybackKeyPair Endpoints\n

\n

For more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.

\n \n

\n RecordingConfiguration Endpoints\n

\n \n

\n Amazon Web Services Tags Endpoints\n

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

\n Introduction\n

\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.

\n

The API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n

For a summary of notable documentation changes in each release, see Document\n History.

\n

\n Allowed Header Values\n

\n \n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

\n

Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).

\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.

\n

At most 50 tags can be applied to a resource.

\n

\n Authentication versus Authorization\n

\n

Note the differences between these concepts:

\n \n

\n Authentication\n

\n

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.

\n

You generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from an IAM user account that has the ivs:PutMetadata\n permission.

\n

For more information:

\n \n

\n Channel Endpoints\n

\n \n

\n StreamKey Endpoints\n

\n \n

\n Stream Endpoints\n

\n \n

\n PlaybackKeyPair Endpoints\n

\n

For more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.

\n \n

\n RecordingConfiguration Endpoints\n

\n \n

\n Amazon Web Services Tags Endpoints\n

\n ", "smithy.api#title": "Amazon Interactive Video Service" }, "version": "2020-07-14", @@ -169,7 +169,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object specifying a stream’s audio configuration.

" + "smithy.api#documentation": "

Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in\n an encoder). This is part of the IngestConfiguration object and used for\n monitoring stream health.

" } }, "com.amazonaws.ivs#BatchError": { @@ -216,8 +216,7 @@ "smithy.api#documentation": "

Performs GetChannel on multiple ARNs simultaneously.

", "smithy.api#http": { "method": "POST", - "uri": "/BatchGetChannel", - "code": 200 + "uri": "/BatchGetChannel" }, "smithy.api#readonly": {} } @@ -263,8 +262,7 @@ "smithy.api#documentation": "

Performs GetStreamKey on multiple ARNs simultaneously.

", "smithy.api#http": { "method": "POST", - "uri": "/BatchGetStreamKey", - "code": 200 + "uri": "/BatchGetStreamKey" }, "smithy.api#readonly": {} } @@ -355,7 +353,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } }, @@ -478,7 +476,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } }, @@ -552,8 +550,7 @@ "smithy.api#documentation": "

Creates a new channel and an associated stream key to start streaming.

", "smithy.api#http": { "method": "POST", - "uri": "/CreateChannel", - "code": 200 + "uri": "/CreateChannel" } } }, @@ -593,7 +590,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } } @@ -647,8 +644,7 @@ "smithy.api#documentation": "

Creates a new recording configuration, used to enable recording to Amazon S3.

\n

\n Known issue: In the us-east-1 region, if you use the\n Amazon Web Services CLI to create a recording configuration, it returns success even if the\n S3 bucket is in a different region. In this case, the state of the recording\n configuration is CREATE_FAILED (instead of ACTIVE). (In other\n regions, the CLI correctly returns failure if the bucket is in a different region.)

\n

\n Workaround: Ensure that your S3 bucket is in the same\n region as the recording configuration. If you create a recording configuration in a different\n region as your S3 bucket, delete that recording configuration and create a new one with an S3\n bucket from the correct region.

", "smithy.api#http": { "method": "POST", - "uri": "/CreateRecordingConfiguration", - "code": 200 + "uri": "/CreateRecordingConfiguration" } } }, @@ -671,7 +667,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } }, "thumbnailConfiguration": { @@ -722,8 +718,7 @@ "smithy.api#documentation": "

Creates a stream key, used to initiate a stream, for the specified channel ARN.

\n

Note that CreateChannel creates a stream key. If you subsequently use\n CreateStreamKey on the same channel, it will fail because a stream key already exists and\n there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

", "smithy.api#http": { "method": "POST", - "uri": "/CreateStreamKey", - "code": 200 + "uri": "/CreateStreamKey" } } }, @@ -740,7 +735,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } } @@ -761,6 +756,9 @@ "input": { "target": "com.amazonaws.ivs#DeleteChannelRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" @@ -825,8 +823,7 @@ "smithy.api#documentation": "

Deletes a specified authorization key pair. This invalidates future viewer tokens\n generated using the key pair’s privateKey. For more information, see Setting Up Private\n Channels in the Amazon IVS User Guide.

", "smithy.api#http": { "method": "POST", - "uri": "/DeletePlaybackKeyPair", - "code": 200 + "uri": "/DeletePlaybackKeyPair" } } }, @@ -851,6 +848,9 @@ "input": { "target": "com.amazonaws.ivs#DeleteRecordingConfigurationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" @@ -872,8 +872,7 @@ "smithy.api#documentation": "

Deletes the recording configuration for the specified ARN.

\n

If you try to delete a recording configuration that is associated with a channel, you will\n get an error (409 ConflictException). To avoid this, for all channels that reference the\n recording configuration, first use UpdateChannel to set the\n recordingConfigurationArn field to an empty string, then use\n DeleteRecordingConfiguration.

", "smithy.api#http": { "method": "POST", - "uri": "/DeleteRecordingConfiguration", - "code": 200 + "uri": "/DeleteRecordingConfiguration" } } }, @@ -894,6 +893,9 @@ "input": { "target": "com.amazonaws.ivs#DeleteStreamKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" @@ -966,8 +968,7 @@ "smithy.api#documentation": "

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

", "smithy.api#http": { "method": "POST", - "uri": "/GetChannel", - "code": 200 + "uri": "/GetChannel" }, "smithy.api#readonly": {} } @@ -1018,8 +1019,7 @@ "smithy.api#documentation": "

Gets a specified playback authorization key pair and returns the arn and\n fingerprint. The privateKey held by the caller can be used to\n generate viewer authorization tokens, to grant viewers access to private channels. For more\n information, see Setting Up Private Channels in the Amazon IVS User\n Guide.

", "smithy.api#http": { "method": "POST", - "uri": "/GetPlaybackKeyPair", - "code": 200 + "uri": "/GetPlaybackKeyPair" }, "smithy.api#readonly": {} } @@ -1073,8 +1073,7 @@ "smithy.api#documentation": "

Gets the recording configuration for the specified ARN.

", "smithy.api#http": { "method": "POST", - "uri": "/GetRecordingConfiguration", - "code": 200 + "uri": "/GetRecordingConfiguration" }, "smithy.api#readonly": {} } @@ -1128,8 +1127,7 @@ "smithy.api#documentation": "

Gets information about the active (live) stream on a specified channel.

", "smithy.api#http": { "method": "POST", - "uri": "/GetStream", - "code": 200 + "uri": "/GetStream" }, "smithy.api#readonly": {} } @@ -1157,8 +1155,7 @@ "smithy.api#documentation": "

Gets stream-key information for a specified ARN.

", "smithy.api#http": { "method": "POST", - "uri": "/GetStreamKey", - "code": 200 + "uri": "/GetStreamKey" }, "smithy.api#readonly": {} } @@ -1232,8 +1229,7 @@ "smithy.api#documentation": "

Gets metadata on a specified stream.

", "smithy.api#http": { "method": "POST", - "uri": "/GetStreamSession", - "code": 200 + "uri": "/GetStreamSession" }, "smithy.api#readonly": {} } @@ -1296,8 +1292,7 @@ "smithy.api#documentation": "

Imports the public portion of a new key pair and returns its arn and\n fingerprint. The privateKey can then be used to generate viewer\n authorization tokens, to grant viewers access to private channels. For more information, see\n Setting Up\n Private Channels in the Amazon IVS User Guide.

", "smithy.api#http": { "method": "POST", - "uri": "/ImportPlaybackKeyPair", - "code": 200 + "uri": "/ImportPlaybackKeyPair" } } }, @@ -1320,7 +1315,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Any tags provided with the request are added to the playback key pair tags.

" + "smithy.api#documentation": "

Any tags provided with the request are added to the playback key pair tags. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } } @@ -1404,8 +1399,7 @@ "smithy.api#documentation": "

Gets summary information about all channels in your account, in the Amazon Web Services\n region where the API request is processed. This list can be filtered to match a specified name\n or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If\n you try to use both filters, you will get an error (409 ConflictException).

", "smithy.api#http": { "method": "POST", - "uri": "/ListChannels", - "code": 200 + "uri": "/ListChannels" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -1439,7 +1433,7 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxChannelResults", "traits": { - "smithy.api#documentation": "

Maximum number of channels to return. Default: 50.

" + "smithy.api#documentation": "

Maximum number of channels to return. Default: 100.

" } } } @@ -1482,8 +1476,7 @@ "smithy.api#documentation": "

Gets summary information about playback key pairs. For more information, see Setting Up Private\n Channels in the Amazon IVS User Guide.

", "smithy.api#http": { "method": "POST", - "uri": "/ListPlaybackKeyPairs", - "code": 200 + "uri": "/ListPlaybackKeyPairs" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -1499,13 +1492,13 @@ "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { - "smithy.api#documentation": "

Maximum number of key pairs to return.

" + "smithy.api#documentation": "

The first key pair to retrieve. This is used for pagination; see the\n nextToken response field.

" } }, "maxResults": { "target": "com.amazonaws.ivs#MaxPlaybackKeyPairResults", "traits": { - "smithy.api#documentation": "

The first key pair to retrieve. This is used for pagination; see the\n nextToken response field. Default: 50.

" + "smithy.api#documentation": "

Maximum number of key pairs to return. Default: your service quota or 100, whichever is\n smaller.

" } } } @@ -1551,8 +1544,7 @@ "smithy.api#documentation": "

Gets summary information about all recording configurations in your account, in the\n Amazon Web Services region where the API request is processed.

", "smithy.api#http": { "method": "POST", - "uri": "/ListRecordingConfigurations", - "code": 200 + "uri": "/ListRecordingConfigurations" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -1574,7 +1566,7 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxRecordingConfigurationResults", "traits": { - "smithy.api#documentation": "

Maximum number of recording configurations to return. Default: 50.

" + "smithy.api#documentation": "

Maximum number of recording configurations to return. Default: your service quota or 100,\n whichever is smaller.

" } } } @@ -1620,8 +1612,7 @@ "smithy.api#documentation": "

Gets summary information about stream keys for the specified channel.

", "smithy.api#http": { "method": "POST", - "uri": "/ListStreamKeys", - "code": 200 + "uri": "/ListStreamKeys" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -1650,7 +1641,7 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxStreamKeyResults", "traits": { - "smithy.api#documentation": "

Maximum number of streamKeys to return. Default: 50.

" + "smithy.api#documentation": "

Maximum number of streamKeys to return. Default: 1.

" } } } @@ -1696,8 +1687,7 @@ "smithy.api#documentation": "

Gets a summary of current and previous streams for a specified channel in your account, in\n the AWS region where the API request is processed.

", "smithy.api#http": { "method": "POST", - "uri": "/ListStreamSessions", - "code": 200 + "uri": "/ListStreamSessions" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -1726,7 +1716,7 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxStreamResults", "traits": { - "smithy.api#documentation": "

Maximum number of streams to return. Default: 50.

" + "smithy.api#documentation": "

Maximum number of streams to return. Default: 100.

" } } } @@ -1769,8 +1759,7 @@ "smithy.api#documentation": "

Gets summary information about live streams in your account, in the Amazon Web Services\n region where the API request is processed.

", "smithy.api#http": { "method": "POST", - "uri": "/ListStreams", - "code": 200 + "uri": "/ListStreams" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -1798,7 +1787,7 @@ "maxResults": { "target": "com.amazonaws.ivs#MaxStreamResults", "traits": { - "smithy.api#documentation": "

Maximum number of streams to return. Default: 50.

" + "smithy.api#documentation": "

Maximum number of streams to return. Default: 100.

" } } } @@ -1844,8 +1833,7 @@ "smithy.api#documentation": "

Gets information about Amazon Web Services tags for the specified ARN.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -1856,7 +1844,7 @@ "resourceArn": { "target": "com.amazonaws.ivs#ResourceArn", "traits": { - "smithy.api#documentation": "

The ARN of the resource to be retrieved.

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

The ARN of the resource to be retrieved. The ARN must be URL-encoded.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1880,7 +1868,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 50 + "max": 100 } } }, @@ -1889,7 +1877,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 50 + "max": 100 } } }, @@ -1898,7 +1886,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 50 + "max": 100 } } }, @@ -1916,7 +1904,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 50 + "max": 100 } } }, @@ -1969,7 +1957,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } }, @@ -2024,7 +2012,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } }, @@ -2043,6 +2031,9 @@ "input": { "target": "com.amazonaws.ivs#PutMetadataRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" @@ -2064,8 +2055,7 @@ "smithy.api#documentation": "

Inserts metadata into the active stream of the specified channel. At most 5 requests per\n second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient\n for your needs, we recommend batching your data into a single PutMetadata call.) At most 155\n requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in\n the Amazon IVS User Guide.

", "smithy.api#http": { "method": "POST", - "uri": "/PutMetadata", - "code": 200 + "uri": "/PutMetadata" } } }, @@ -2121,7 +2111,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } }, "thumbnailConfiguration": { @@ -2213,7 +2203,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } }, @@ -2332,8 +2322,7 @@ "smithy.api#documentation": "

Disconnects the incoming RTMPS stream for the specified channel. Can be used in\n conjunction with DeleteStreamKey to prevent further streaming to a\n channel.

\n \n

Many streaming client-software libraries automatically reconnect a dropped RTMPS\n session, so to stop the stream permanently, you may want to first revoke the\n streamKey attached to the channel.

\n ", "smithy.api#http": { "method": "POST", - "uri": "/StopStream", - "code": 200 + "uri": "/StopStream" } } }, @@ -2377,7 +2366,7 @@ "startTime": { "target": "com.amazonaws.ivs#StreamStartTime", "traits": { - "smithy.api#documentation": "

Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

" + "smithy.api#documentation": "

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is\n returned as a string.

" } }, "state": { @@ -2421,7 +2410,7 @@ "eventTime": { "target": "com.amazonaws.ivs#Time", "traits": { - "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the event occurred.

" + "smithy.api#documentation": "

Time when the event occurred. This is an ISO 8601 timestamp; note that this is\n returned as a string.

" } } }, @@ -2507,7 +2496,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } }, @@ -2561,7 +2550,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

" } } }, @@ -2608,13 +2597,13 @@ "startTime": { "target": "com.amazonaws.ivs#Time", "traits": { - "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went live.

" + "smithy.api#documentation": "

Time when the channel went live. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "endTime": { "target": "com.amazonaws.ivs#Time", "traits": { - "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this\n is NULL.

" + "smithy.api#documentation": "

Time when the channel went offline. This is an ISO 8601 timestamp; note that\n this is returned as a string. For live streams, this is NULL.

" } }, "channel": { @@ -2664,13 +2653,13 @@ "startTime": { "target": "com.amazonaws.ivs#Time", "traits": { - "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went live.

" + "smithy.api#documentation": "

Time when the channel went live. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "endTime": { "target": "com.amazonaws.ivs#Time", "traits": { - "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this\n is NULL.

" + "smithy.api#documentation": "

Time when the channel went offline. This is an ISO 8601 timestamp; note that\n this is returned as a string. For live streams, this is NULL.

" } }, "hasErrorEvent": { @@ -2741,7 +2730,7 @@ "startTime": { "target": "com.amazonaws.ivs#StreamStartTime", "traits": { - "smithy.api#documentation": "

Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

" + "smithy.api#documentation": "

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is\n returned as a string.

" } } }, @@ -2815,8 +2804,7 @@ "smithy.api#documentation": "

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" } } }, @@ -2826,7 +2814,7 @@ "resourceArn": { "target": "com.amazonaws.ivs#ResourceArn", "traits": { - "smithy.api#documentation": "

ARN of the resource for which tags are to be added or updated.

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

ARN of the resource for which tags are to be added or updated. The ARN must be\n URL-encoded.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2834,7 +2822,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of tags to be added or updated.

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

Array of tags to be added or updated. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

", "smithy.api#required": {} } } @@ -2941,8 +2929,7 @@ "smithy.api#documentation": "

Removes tags from the resource with the specified ARN.

", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -2953,7 +2940,7 @@ "resourceArn": { "target": "com.amazonaws.ivs#ResourceArn", "traits": { - "smithy.api#documentation": "

ARN of the resource for which tags are to be removed.

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

ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2961,7 +2948,7 @@ "tagKeys": { "target": "com.amazonaws.ivs#TagKeyList", "traits": { - "smithy.api#documentation": "

Array of tags to be removed.

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

Array of tags to be removed. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -3001,8 +2988,7 @@ "smithy.api#documentation": "

Updates a channel's configuration. This does not affect an ongoing stream of this channel.\n You must stop and restart the stream for the changes to take effect.

", "smithy.api#http": { "method": "POST", - "uri": "/UpdateChannel", - "code": 200 + "uri": "/UpdateChannel" } } }, @@ -3125,7 +3111,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object specifying a stream’s video configuration.

" + "smithy.api#documentation": "

Object specifying a stream’s video configuration, as set up by the broadcaster (usually in\n an encoder). This is part of the IngestConfiguration object and used for\n monitoring stream health.

" } }, "com.amazonaws.ivs#errorCode": { diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index 7f772930c3c..acca5b05e7d 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -277,7 +277,7 @@ "KeyPath": { "target": "com.amazonaws.kendra#S3ObjectKey", "traits": { - "smithy.api#documentation": "

Path to the Amazon Web Services S3 bucket that contains the ACL files.

" + "smithy.api#documentation": "

Path to the Amazon S3 bucket that contains the ACL files.

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

A list of regular expression patterns to exclude certain blog posts, pages,\n spaces, or attachments in your Confluence. Content that matches the patterns are \n excluded from the index. Content that doesn't match the patterns is included in \n the index. If content matches both an inclusion and exclusion pattern, the \n exclusion pattern takes precedence and the content isn't included in the index.

" } + }, + "ProxyConfiguration": { + "target": "com.amazonaws.kendra#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information to connect to your Confluence URL instance via a web proxy. \n You can use this option for Confluence Server.

\n

You must provide the website host name and port number. For example, the host name of \n https://a.example.com/page1.html is \"a.example.com\" and the port \n is 443, the standard port for HTTPS.

\n

Web proxy credentials are optional and you can use them to connect to a web proxy \n server that requires basic authentication of user name and password. To store web \n proxy credentials, you use a secret in Secrets Manager.

\n

It is recommended that you follow best security practices when configuring your \n web proxy. This includes setting up throttling, setting up logging and monitoring, \n and applying security patches on a regular basis. If you use your web proxy with \n multiple data sources, sync jobs that occur at the same time could strain the load \n on your proxy. It is recommended you prepare your proxy beforehand for any security \n and load requirements.

" + } } }, "traits": { @@ -2218,7 +2224,7 @@ "Name": { "target": "com.amazonaws.kendra#DataSourceName", "traits": { - "smithy.api#documentation": "

A unique name for the data source connector. A data source name can't be changed\n without deleting and recreating the data source connector.

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

A name for the data source connector.

", "smithy.api#required": {} } }, @@ -2242,6 +2248,12 @@ "smithy.api#documentation": "

Configuration information to connect to your data source repository.

\n

You can't specify the Configuration parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.

\n

The Configuration parameter is required for all other\n data sources.

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

Configuration information for an Amazon Virtual Private Cloud to connect to your \n data source. For more information, see Configuring a VPC.

" + } + }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { @@ -2943,6 +2955,12 @@ "traits": { "smithy.api#documentation": "

Provides the configuration information to connect to Alfresco as your \n data source.

" } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.kendra#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "

Provides a template for the configuration information to connect \n to your data source.

" + } } }, "traits": { @@ -3420,6 +3438,10 @@ { "value": "ALFRESCO", "name": "ALFRESCO" + }, + { + "value": "TEMPLATE", + "name": "TEMPLATE" } ] } @@ -4113,7 +4135,7 @@ "Name": { "target": "com.amazonaws.kendra#DataSourceName", "traits": { - "smithy.api#documentation": "

The name that you gave the data source when it was created.

" + "smithy.api#documentation": "

The name for the data source.

" } }, "Type": { @@ -4128,6 +4150,12 @@ "smithy.api#documentation": "

Configuration details for the data source. This shows how the \n data source is configured. The configuration options for a data \n source depend on the data source provider.

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

Configuration information for an Amazon Virtual Private Cloud to connect to your \n data source. For more information, see Configuring a VPC.

" + } + }, "CreatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { @@ -9801,7 +9829,7 @@ "FolderIds": { "target": "com.amazonaws.kendra#FolderIdList", "traits": { - "smithy.api#documentation": "

The identifiers of the Quip folders you want to index.

" + "smithy.api#documentation": "

The identifiers of the Quip folders you want to index. You \n can find in your browser URL when you access your folder\n in Quip. For example, \n https://quip-company.com/zlLuOVNSarTL/folder-name.

" } }, "ThreadFieldMappings": { @@ -10984,6 +11012,12 @@ "traits": { "smithy.api#documentation": "

Whether you want to connect to SharePoint using basic authentication of \n user name and password, or OAuth authentication of user name, password, \n client ID, and client secret. You can use OAuth authentication for \n SharePoint Online.

" } + }, + "ProxyConfiguration": { + "target": "com.amazonaws.kendra#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information to connect to your Microsoft SharePoint site URLs \n via instance via a web proxy. You can use this option for SharePoint Server.

\n

You must provide the website host name and port number. For example, the host name of \n https://a.example.com/page1.html is \"a.example.com\" and the port \n is 443, the standard port for HTTPS.

\n

Web proxy credentials are optional and you can use them to connect to a web proxy \n server that requires basic authentication of user name and password. To store web \n proxy credentials, you use a secret in Secrets Manager.

\n

It is recommended that you follow best security practices when configuring your \n web proxy. This includes setting up throttling, setting up logging and monitoring, \n and applying security patches on a regular basis. If you use your web proxy with \n multiple data sources, sync jobs that occur at the same time could strain the load \n on your proxy. It is recommended you prepare your proxy beforehand for any security \n and load requirements.

" + } } }, "traits": { @@ -11845,6 +11879,26 @@ "smithy.api#pattern": "^[A-Z0-9]*$" } }, + "com.amazonaws.kendra#Template": { + "type": "document", + "traits": { + "smithy.api#documentation": "

The template schema used for the data source.

\n

The following links to the template schema for data sources \n where templates are supported:

\n " + } + }, + "com.amazonaws.kendra#TemplateConfiguration": { + "type": "structure", + "members": { + "Template": { + "target": "com.amazonaws.kendra#Template", + "traits": { + "smithy.api#documentation": "

The template schema used for the data source.

\n

The following links to the template schema for data sources \n where templates are supported:

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

Provides a template for the configuration information to connect \n to your data source.

" + } + }, "com.amazonaws.kendra#TenantDomain": { "type": "string", "traits": { @@ -12244,7 +12298,7 @@ "Name": { "target": "com.amazonaws.kendra#DataSourceName", "traits": { - "smithy.api#documentation": "

A new name for the data source connector. You must \n first delete the data source and re-create it to change the \n name of the data source.

" + "smithy.api#documentation": "

A new name for the data source connector.

" } }, "IndexId": { @@ -12260,6 +12314,12 @@ "smithy.api#documentation": "

Configuration information you want to update for the data source connector.

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

Configuration information for an Amazon Virtual Private Cloud to connect to your \n data source. For more information, see Configuring a VPC.

" + } + }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { diff --git a/codegen/sdk/aws-models/lakeformation.json b/codegen/sdk/aws-models/lakeformation.json index f4777a021ee..1daba89b9df 100644 --- a/codegen/sdk/aws-models/lakeformation.json +++ b/codegen/sdk/aws-models/lakeformation.json @@ -51,6 +51,9 @@ { "target": "com.amazonaws.lakeformation#AddLFTagsToResource" }, + { + "target": "com.amazonaws.lakeformation#AssumeDecoratedRoleWithSAML" + }, { "target": "com.amazonaws.lakeformation#BatchGrantPermissions" }, @@ -331,6 +334,101 @@ "smithy.api#error": "client" } }, + "com.amazonaws.lakeformation#AssumeDecoratedRoleWithSAML": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#AssumeDecoratedRoleWithSAMLRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#AssumeDecoratedRoleWithSAMLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions.\n Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.\n

\n

\n This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API GetDataAccess. Therefore, all SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a role would look as follows:\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/AssumeDecoratedRoleWithSAML", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#AssumeDecoratedRoleWithSAMLRequest": { + "type": "structure", + "members": { + "SAMLAssertion": { + "target": "com.amazonaws.lakeformation#SAMLAssertionString", + "traits": { + "smithy.api#documentation": "

A SAML assertion consisting of an assertion statement for the user who needs temporary credentials. This must match the SAML assertion that was issued to IAM. This must be Base64 encoded.

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

The role that represents an IAM principal whose scope down policy allows it to call credential vending APIs such as GetTemporaryTableCredentials. The caller must also have iam:PassRole permission on this role.

", + "smithy.api#required": {} + } + }, + "PrincipalArn": { + "target": "com.amazonaws.lakeformation#IAMSAMLProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

", + "smithy.api#required": {} + } + }, + "DurationSeconds": { + "target": "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger", + "traits": { + "smithy.api#documentation": "

The time period, between 900 and 43,200 seconds, for the timeout of the temporary credentials.

" + } + } + } + }, + "com.amazonaws.lakeformation#AssumeDecoratedRoleWithSAMLResponse": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.lakeformation#AccessKeyIdString", + "traits": { + "smithy.api#documentation": "

The access key ID for the temporary credentials. (The access key consists of an access key ID and a secret key).

" + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.lakeformation#SecretAccessKeyString", + "traits": { + "smithy.api#documentation": "

The secret key for the temporary credentials. (The access key consists of an access key ID and a secret key).

" + } + }, + "SessionToken": { + "target": "com.amazonaws.lakeformation#SessionTokenString", + "traits": { + "smithy.api#documentation": "

The session token for the temporary credentials.

" + } + }, + "Expiration": { + "target": "com.amazonaws.lakeformation#ExpirationTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the temporary credentials expire.

" + } + } + } + }, "com.amazonaws.lakeformation#AuditContext": { "type": "structure", "members": { @@ -1037,7 +1135,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 10 + "max": 30 } } }, @@ -1286,7 +1384,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified LF-tag key name. If the attribute key does not exist or the LF-tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message \"Delete not allowed\" as the LF-tag key is still attached with resources. You can consider untagging resources with this LF-tag key.

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

Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteLFTag", @@ -2737,6 +2835,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "WorkUnitRanges", "pageSize": "PageSize" } } @@ -2893,6 +2992,12 @@ "smithy.api#pattern": "^arn:aws:iam::[0-9]*:role/" } }, + "com.amazonaws.lakeformation#IAMSAMLProviderArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:iam::[0-9]*:saml-provider/" + } + }, "com.amazonaws.lakeformation#Identifier": { "type": "string", "traits": { @@ -4499,6 +4604,15 @@ "smithy.api#documentation": "

A PartiQL predicate.

" } }, + "com.amazonaws.lakeformation#SAMLAssertionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 100000 + } + } + }, "com.amazonaws.lakeformation#SearchDatabasesByLFTags": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/lambda.json b/codegen/sdk/aws-models/lambda.json index df2327634db..e2fa32bf6f7 100644 --- a/codegen/sdk/aws-models/lambda.json +++ b/codegen/sdk/aws-models/lambda.json @@ -681,6 +681,20 @@ "smithy.api#documentation": "

List of signing profiles that can sign a code package.

" } }, + "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig": { + "type": "structure", + "members": { + "ConsumerGroupId": { + "target": "com.amazonaws.lambda#URI", + "traits": { + "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources.\n After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see\n services-msk-consumer-group-id.

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

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" + } + }, "com.amazonaws.lambda#Architecture": { "type": "string", "traits": { @@ -1135,7 +1149,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the\n event source and triggers the function.

\n

For details about how to configure different event sources, see the following topics.

\n \n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n \n

For information about which configuration parameters apply to each event source, see the following topics.

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

Creates a mapping between an event source and an Lambda function. Lambda reads items from the\n event source and invokes the function.

\n

For details about how to configure different event sources, see the following topics.

\n \n \n

The following error handling options are available only for stream sources (DynamoDB and Kinesis):

\n \n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/event-source-mappings", @@ -1168,7 +1182,7 @@ "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

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

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n " } }, "FilterCriteria": { @@ -1192,7 +1206,7 @@ "StartingPosition": { "target": "com.amazonaws.lambda#EventSourcePosition", "traits": { - "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon\n MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

" + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon\n DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams.

" } }, "StartingPositionTimestamp": { @@ -1222,13 +1236,13 @@ "MaximumRetryAttempts": { "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.

" + "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" } }, "TumblingWindowInSeconds": { "target": "com.amazonaws.lambda#TumblingWindowInSeconds", "traits": { - "smithy.api#documentation": "

(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

" + "smithy.api#documentation": "

(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.

" } }, "Topics": { @@ -1252,7 +1266,7 @@ "SelfManagedEventSource": { "target": "com.amazonaws.lambda#SelfManagedEventSource", "traits": { - "smithy.api#documentation": "

The Self-Managed Apache Kafka cluster to send records.

" + "smithy.api#documentation": "

The self-managed Apache Kafka cluster to receive records from.

" } }, "FunctionResponseTypes": { @@ -1260,6 +1274,18 @@ "traits": { "smithy.api#documentation": "

(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.

" } + }, + "AmazonManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" + } + }, + "SelfManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a self-managed Apache Kafka event source.

" + } } } }, @@ -2544,6 +2570,18 @@ "traits": { "smithy.api#documentation": "

(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.

" } + }, + "AmazonManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" + } + }, + "SelfManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "

Specific configuration settings for a self-managed Apache Kafka event source.

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

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or\n asynchronously. To invoke a function asynchronously, set InvocationType to Event.

\n \n

For synchronous invocation,\n details about the function response, including errors, are included in the response body and headers. For either\n invocation type, you can find more information in the execution log and trace.

\n \n

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type,\n client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an\n error, Lambda executes the function up to two more times. For more information, see Retry Behavior.

\n \n

For asynchronous invocation,\n Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity\n to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple\n times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

\n \n

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that\n prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration.\n For example, Lambda returns TooManyRequestsException if executing the function would cause you to\n exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or\n function level (ReservedFunctionConcurrentInvocationLimitExceeded).

\n \n

For functions with a long timeout, your client might be disconnected during synchronous invocation while it\n waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long\n connections with timeout or keep-alive settings.

\n \n

This operation requires permission for the lambda:InvokeFunction action.

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

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or\n asynchronously. To invoke a function asynchronously, set InvocationType to Event.

\n \n

For synchronous invocation,\n details about the function response, including errors, are included in the response body and headers. For either\n invocation type, you can find more information in the execution log and trace.

\n \n

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type,\n client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an\n error, Lambda executes the function up to two more times. For more information, see Retry Behavior.

\n \n

For asynchronous invocation,\n Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity\n to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple\n times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

\n \n

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that\n prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration.\n For example, Lambda returns TooManyRequestsException if executing the function would cause you to\n exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or\n function level (ReservedFunctionConcurrentInvocationLimitExceeded).

\n \n

For functions with a long timeout, your client might be disconnected during synchronous invocation while it\n waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long\n connections with timeout or keep-alive settings.

\n \n

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up\n permissions for cross-account invocations, see Granting function\n access to other accounts.

", "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/functions/{FunctionName}/invocations", @@ -5360,7 +5398,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a\n single event source.

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

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a\n single event source.

", "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/event-source-mappings", @@ -7553,6 +7591,20 @@ "smithy.api#documentation": "

The self-managed Apache Kafka cluster for your event source.

" } }, + "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig": { + "type": "structure", + "members": { + "ConsumerGroupId": { + "target": "com.amazonaws.lambda#URI", + "traits": { + "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources.\n After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see\n services-msk-consumer-group-id.

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

Specific configuration settings for a self-managed Apache Kafka event source.

" + } + }, "com.amazonaws.lambda#SensitiveString": { "type": "string", "traits": { @@ -7593,7 +7645,7 @@ "Type": { "target": "com.amazonaws.lambda#SourceAccessType", "traits": { - "smithy.api#documentation": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

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

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

\n " } }, "URI": { @@ -8296,7 +8348,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.

\n

For details about how to configure different event sources, see the following topics.

\n \n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n \n

For information about which configuration parameters apply to each event source, see the following topics.

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

Updates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.

\n

For details about how to configure different event sources, see the following topics.

\n \n \n

The following error handling options are available only for stream sources (DynamoDB and Kinesis):

\n \n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -8330,7 +8382,7 @@ "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

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

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n " } }, "FilterCriteria": { @@ -8366,7 +8418,7 @@ "MaximumRetryAttempts": { "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.

" + "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" } }, "ParallelizationFactor": { @@ -8384,7 +8436,7 @@ "TumblingWindowInSeconds": { "target": "com.amazonaws.lambda#TumblingWindowInSeconds", "traits": { - "smithy.api#documentation": "

(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

" + "smithy.api#documentation": "

(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.

" } }, "FunctionResponseTypes": { diff --git a/codegen/sdk/aws-models/lex-models-v2.json b/codegen/sdk/aws-models/lex-models-v2.json index 872f1272e33..3573bbf21da 100644 --- a/codegen/sdk/aws-models/lex-models-v2.json +++ b/codegen/sdk/aws-models/lex-models-v2.json @@ -1647,6 +1647,30 @@ "smithy.api#documentation": "

Contains information about code hooks that Amazon Lex calls during a\n conversation.

" } }, + "com.amazonaws.lexmodelsv2#Condition": { + "type": "structure", + "members": { + "expressionString": { + "target": "com.amazonaws.lexmodelsv2#ConditionExpression", + "traits": { + "smithy.api#documentation": "

The expression string that is evaluated.

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

Provides an expression that evaluates to true or false.

" + } + }, + "com.amazonaws.lexmodelsv2#ConditionExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.lexmodelsv2#ConditionKey": { "type": "string", "traits": { @@ -1703,6 +1727,79 @@ } } }, + "com.amazonaws.lexmodelsv2#ConditionalBranch": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "

The name of the branch.

", + "smithy.api#required": {} + } + }, + "condition": { + "target": "com.amazonaws.lexmodelsv2#Condition", + "traits": { + "smithy.api#documentation": "

Contains the expression to evaluate. If the condition is true, the\n branch's actions are taken.

", + "smithy.api#required": {} + } + }, + "nextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

The next step in the conversation.

", + "smithy.api#required": {} + } + }, + "response": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + } + }, + "traits": { + "smithy.api#documentation": "

A set of actions that Amazon Lex should run if the condition\n is matched.

" + } + }, + "com.amazonaws.lexmodelsv2#ConditionalBranches": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ConditionalBranch" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.lexmodelsv2#ConditionalSpecification": { + "type": "structure", + "members": { + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Determines whether a conditional branch is active. When\n active is false, the conditions are not\n evaluated.

", + "smithy.api#required": {} + } + }, + "conditionalBranches": { + "target": "com.amazonaws.lexmodelsv2#ConditionalBranches", + "traits": { + "smithy.api#documentation": "

A list of conditional branches. A conditional branch is made up of a\n condition, a response and a next step. The response and next step are\n executed when the condition is true.

", + "smithy.api#required": {} + } + }, + "defaultBranch": { + "target": "com.amazonaws.lexmodelsv2#DefaultConditionalBranch", + "traits": { + "smithy.api#documentation": "

The conditional branch that should be followed when the conditions\n for other branches are not satisfied. A conditional branch is made up\n of a condition, a response and a next step.

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

Provides a list of conditional branches. Branches are evaluated in\n the order that they are entered in the list. The first branch with a\n condition that evaluates to true is executed. The last branch in the\n list is the default branch. The default branch should not have any condition\n expression. The default branch is executed if no other branch has a\n matching condition.

" + } + }, "com.amazonaws.lexmodelsv2#ConfidenceThreshold": { "type": "double", "traits": { @@ -2557,6 +2654,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "initialResponseSetting": { + "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", + "traits": { + "smithy.api#documentation": "

Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.

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

A timestamp of the date and time that the intent was created.

" } + }, + "initialResponseSetting": { + "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", + "traits": { + "smithy.api#documentation": "

Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.

" + } } } }, @@ -3410,6 +3519,23 @@ "smithy.api#documentation": "

The object used for specifying the data range that the customer\n wants Amazon Lex to read through in the input transcripts.

" } }, + "com.amazonaws.lexmodelsv2#DefaultConditionalBranch": { + "type": "structure", + "members": { + "nextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

The next step in the conversation.

" + } + }, + "response": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + } + }, + "traits": { + "smithy.api#documentation": "

A set of actions that Amazon Lex should run if none of the\n other conditions are met.

" + } + }, "com.amazonaws.lexmodelsv2#DeleteBot": { "type": "operation", "input": { @@ -5927,6 +6053,12 @@ "traits": { "smithy.api#documentation": "

A timestamp of the date and time that the intent was last\n updated.

" } + }, + "initialResponseSetting": { + "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", + "traits": { + "smithy.api#documentation": "

" + } } } }, @@ -6310,6 +6442,111 @@ } } }, + "com.amazonaws.lexmodelsv2#DialogAction": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.lexmodelsv2#DialogActionType", + "traits": { + "smithy.api#documentation": "

The action that the bot should execute.

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

If the dialog action is ElicitSlot, defines the slot to\n elicit from the user.

" + } + }, + "suppressNextMessage": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

When true the next message for the intent is not used.

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

Defines the action that the bot executes at runtime when the\n conversation reaches this step.

" + } + }, + "com.amazonaws.lexmodelsv2#DialogActionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ElicitIntent", + "name": "ElicitIntent" + }, + { + "value": "StartIntent", + "name": "StartIntent" + }, + { + "value": "ElicitSlot", + "name": "ElicitSlot" + }, + { + "value": "EvaluateConditional", + "name": "EvaluateConditional" + }, + { + "value": "InvokeDialogCodeHook", + "name": "InvokeDialogCodeHook" + }, + { + "value": "ConfirmIntent", + "name": "ConfirmIntent" + }, + { + "value": "FulfillIntent", + "name": "FulfillIntent" + }, + { + "value": "CloseIntent", + "name": "CloseIntent" + }, + { + "value": "EndConversation", + "name": "EndConversation" + } + ] + } + }, + "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting": { + "type": "structure", + "members": { + "enableCodeHookInvocation": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a Lambda function should be invoked\n for the dialog.

", + "smithy.api#required": {} + } + }, + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Determines whether a dialog code hook is used when the intent is\n activated.

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

A label that indicates the dialog step from which the dialog code\n hook is happening.

" + } + }, + "postCodeHookSpecification": { + "target": "com.amazonaws.lexmodelsv2#PostDialogCodeHookInvocationSpecification", + "traits": { + "smithy.api#documentation": "

Contains the responses and actions that Amazon Lex takes\n after the Lambda function is complete.

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

Settings that specify the dialog code hook that is\n called by Amazon Lex at a step of the conversation.

" + } + }, "com.amazonaws.lexmodelsv2#DialogCodeHookSettings": { "type": "structure", "members": { @@ -6325,6 +6562,26 @@ "smithy.api#documentation": "

Settings that determine the Lambda function that Amazon Lex uses for\n processing user responses.

" } }, + "com.amazonaws.lexmodelsv2#DialogState": { + "type": "structure", + "members": { + "dialogAction": { + "target": "com.amazonaws.lexmodelsv2#DialogAction" + }, + "intent": { + "target": "com.amazonaws.lexmodelsv2#IntentOverride" + }, + "sessionAttributes": { + "target": "com.amazonaws.lexmodelsv2#StringMap", + "traits": { + "smithy.api#documentation": "

Map of key/value pairs representing session-specific context\n information. It contains application information passed between Amazon Lex and a client application.

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

The current state of the conversation with the user.

" + } + }, "com.amazonaws.lexmodelsv2#DraftBotVersion": { "type": "string", "traits": { @@ -6350,6 +6607,27 @@ ] } }, + "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting": { + "type": "structure", + "members": { + "enableCodeHookInvocation": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a Lambda function should be invoked\n for the dialog.

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

A label that indicates the dialog step from which the dialog code\n hook is happening.

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

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

" + } + }, "com.amazonaws.lexmodelsv2#EncryptionSetting": { "type": "structure", "members": { @@ -6654,6 +6932,12 @@ "traits": { "smithy.api#documentation": "

Provides settings for update messages sent to the user for\n long-running Lambda fulfillment functions. Fulfillment updates can be\n used only with streaming conversations.

" } + }, + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Determines whether the fulfillment code hook is used. When\n active is false, the code hook doesn't run.

" + } } }, "traits": { @@ -7132,6 +7416,29 @@ "smithy.api#pattern": "^([0-9a-zA-Z_])+$" } }, + "com.amazonaws.lexmodelsv2#InitialResponseSetting": { + "type": "structure", + "members": { + "initialResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "nextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

The next step in the conversation.

" + } + }, + "conditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification" + }, + "codeHook": { + "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting" + } + }, + "traits": { + "smithy.api#documentation": "

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

" + } + }, "com.amazonaws.lexmodelsv2#InputContext": { "type": "structure", "members": { @@ -7165,8 +7472,7 @@ "closingResponse": { "target": "com.amazonaws.lexmodelsv2#ResponseSpecification", "traits": { - "smithy.api#documentation": "

The response that Amazon Lex sends to the user when the intent is\n complete.

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

The response that Amazon Lex sends to the user when the intent is\n complete.

" } }, "active": { @@ -7174,6 +7480,18 @@ "traits": { "smithy.api#documentation": "

Specifies whether an intent's closing response is used. When this\n field is false, the closing response isn't sent to the user. If the\n active field isn't specified, the default is\n true.

" } + }, + "nextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step that the bot executes after playing the\n intent's closing response.

" + } + }, + "conditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches associated with the intent's closing\n response. These branches are executed when the nextStep\n attribute is set to EvalutateConditional.

" + } } }, "traits": { @@ -7193,8 +7511,7 @@ "declinationResponse": { "target": "com.amazonaws.lexmodelsv2#ResponseSpecification", "traits": { - "smithy.api#documentation": "

When the user answers \"no\" to the question defined in\n promptSpecification, Amazon Lex responds with this response\n to acknowledge that the intent was canceled.

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

When the user answers \"no\" to the question defined in\n promptSpecification, Amazon Lex responds with this response\n to acknowledge that the intent was canceled.

" } }, "active": { @@ -7202,6 +7519,57 @@ "traits": { "smithy.api#documentation": "

Specifies whether the intent's confirmation is sent to the user.\n When this field is false, confirmation and declination responses aren't\n sent. If the active field isn't specified, the default is\n true.

" } + }, + "confirmationResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "confirmationNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step that the bot executes when the customer\n confirms the intent.

" + } + }, + "confirmationConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate after the intent is\n closed.

" + } + }, + "declinationNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step that the bot executes when the customer\n declines the intent.

" + } + }, + "declinationConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate after the intent is\n declined.

" + } + }, + "failureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

The next step to take in the conversation if the confirmation step\n fails.

" + } + }, + "failureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification" + }, + "codeHook": { + "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting", + "traits": { + "smithy.api#documentation": "

The DialogCodeHookInvocationSetting object associated\n with intent's confirmation step. The dialog code hook is triggered\n based on these invocation settings when the confirmation next step or\n declination next step or failure next step is\n InvokeDialogCodeHook.

" + } + }, + "elicitationCodeHook": { + "target": "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting", + "traits": { + "smithy.api#documentation": "

The DialogCodeHookInvocationSetting used when the code\n hook is invoked during confirmation prompt retries.

" + } } }, "traits": { @@ -7275,6 +7643,26 @@ } } }, + "com.amazonaws.lexmodelsv2#IntentOverride": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "

The name of the intent. Only required when you're switching\n intents.

" + } + }, + "slots": { + "target": "com.amazonaws.lexmodelsv2#SlotValueOverrideMap", + "traits": { + "smithy.api#documentation": "

A map of all of the slot value overrides for the intent. The name of\n the slot maps to the value of the slot. Slots that are not included in\n the map aren't overridden.,

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

Override settings to configure the intent state.

" + } + }, "com.amazonaws.lexmodelsv2#IntentSignature": { "type": "string" }, @@ -9511,6 +9899,14 @@ "com.amazonaws.lexmodelsv2#NextToken": { "type": "string" }, + "com.amazonaws.lexmodelsv2#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.lexmodelsv2#NumericalBotVersion": { "type": "string", "traits": { @@ -9675,6 +10071,59 @@ } } }, + "com.amazonaws.lexmodelsv2#PostDialogCodeHookInvocationSpecification": { + "type": "structure", + "members": { + "successResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "successNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifics the next step the bot runs after the dialog code hook\n finishes successfully.

" + } + }, + "successConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate after the dialog code\n hook finishes successfully.

" + } + }, + "failureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step the bot runs after the dialog code hook\n throws an exception or returns with the State field of the\n Intent object set to Failed.

" + } + }, + "failureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate after the dialog code\n hook throws an exception or returns with the State field\n of the Intent object set to Failed.

" + } + }, + "timeoutResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "timeoutNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step that the bot runs when the code hook times\n out.

" + } + }, + "timeoutConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate if the code hook times\n out.

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

Specifies next steps to run after the dialog code hook\n finishes.

" + } + }, "com.amazonaws.lexmodelsv2#PostFulfillmentStatusSpecification": { "type": "structure", "members": { @@ -9686,6 +10135,42 @@ }, "timeoutResponse": { "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "successNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step in the conversation that Amazon Lex\n invokes when the fulfillment code hook completes successfully.

" + } + }, + "successConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate after the fulfillment\n code hook finishes successfully.

" + } + }, + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step the bot runs after the fulfillment code hook\n throws an exception or returns with the State field of the\n Intent object set to Failed.

" + } + }, + "failureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate after the fulfillment\n code hook throws an exception or returns with the State\n field of the Intent object set to\n Failed.

" + } + }, + "timeoutNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step that the bot runs when the fulfillment code\n hook times out.

" + } + }, + "timeoutConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate if the fulfillment code\n hook times out.

" + } } }, "traits": { @@ -10331,6 +10816,56 @@ "com.amazonaws.lexmodelsv2#SkipResourceInUseCheck": { "type": "boolean" }, + "com.amazonaws.lexmodelsv2#SlotCaptureSetting": { + "type": "structure", + "members": { + "captureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "captureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step that the bot runs when the slot value is\n captured before the code hook times out.

" + } + }, + "captureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate after the slot value is\n captured.

" + } + }, + "failureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "

Specifies the next step that the bot runs when the slot value code\n is not recognized.

" + } + }, + "failureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "

A list of conditional branches to evaluate when the slot value isn't\n captured.

" + } + }, + "codeHook": { + "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting", + "traits": { + "smithy.api#documentation": "

Code hook called after Amazon Lex successfully captures a\n slot value.

" + } + }, + "elicitationCodeHook": { + "target": "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting", + "traits": { + "smithy.api#documentation": "

Code hook called when Amazon Lex doesn't capture a slot\n value.

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

Settings used when Amazon Lex successfully captures a slot\n value from a user.

" + } + }, "com.amazonaws.lexmodelsv2#SlotConstraint": { "type": "string", "traits": { @@ -10492,6 +11027,21 @@ "smithy.api#documentation": "

Sets the priority that Amazon Lex should use when eliciting slot values\n from a user.

" } }, + "com.amazonaws.lexmodelsv2#SlotShape": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Scalar", + "name": "Scalar" + }, + { + "value": "List", + "name": "List" + } + ] + } + }, "com.amazonaws.lexmodelsv2#SlotSortAttribute": { "type": "string", "traits": { @@ -10811,6 +11361,20 @@ } } }, + "com.amazonaws.lexmodelsv2#SlotValue": { + "type": "structure", + "members": { + "interpretedValue": { + "target": "com.amazonaws.lexmodelsv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value that Amazon Lex determines for the slot. The\n actual value depends on the setting of the value selection strategy for\n the bot. You can choose to use the value entered by the user, or you\n can have Amazon Lex choose the first value in the\n resolvedValues list.

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

The value to set in a slot.

" + } + }, "com.amazonaws.lexmodelsv2#SlotValueElicitationSetting": { "type": "structure", "members": { @@ -10841,12 +11405,53 @@ }, "waitAndContinueSpecification": { "target": "com.amazonaws.lexmodelsv2#WaitAndContinueSpecification" + }, + "slotCaptureSetting": { + "target": "com.amazonaws.lexmodelsv2#SlotCaptureSetting", + "traits": { + "smithy.api#documentation": "

Specifies the settings that Amazon Lex uses when a slot\n value is successfully entered by a user.

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

Settings that you can use for eliciting a slot value.

" } }, + "com.amazonaws.lexmodelsv2#SlotValueOverride": { + "type": "structure", + "members": { + "shape": { + "target": "com.amazonaws.lexmodelsv2#SlotShape", + "traits": { + "smithy.api#documentation": "

When the shape value is List, it indicates that the\n values field contains a list of slot values. When the\n value is Scalar, it indicates that the value\n field contains a single value.

" + } + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#SlotValue", + "traits": { + "smithy.api#documentation": "

The current value of the slot.

" + } + }, + "values": { + "target": "com.amazonaws.lexmodelsv2#SlotValues", + "traits": { + "smithy.api#documentation": "

A list of one or more values that the user provided for the slot.\n For example, for a slot that elicits pizza toppings, the values\n might be \"pepperoni\" and \"pineapple.\"

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

The slot values that Amazon Lex uses when it sets slot\n values in a dialog step.

" + } + }, + "com.amazonaws.lexmodelsv2#SlotValueOverrideMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#Name" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#SlotValueOverride" + } + }, "com.amazonaws.lexmodelsv2#SlotValueRegexFilter": { "type": "structure", "members": { @@ -10904,6 +11509,12 @@ "smithy.api#documentation": "

Contains settings used by Amazon Lex to select a slot value.

" } }, + "com.amazonaws.lexmodelsv2#SlotValues": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SlotValueOverride" + } + }, "com.amazonaws.lexmodelsv2#SortOrder": { "type": "string", "traits": { @@ -11213,6 +11824,18 @@ } } }, + "com.amazonaws.lexmodelsv2#String": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#StringMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#String" + } + }, "com.amazonaws.lexmodelsv2#SynonymList": { "type": "list", "member": { @@ -12377,6 +13000,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "initialResponseSetting": { + "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", + "traits": { + "smithy.api#documentation": "

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

A timestamp of the last time that the intent was modified.

" } + }, + "initialResponseSetting": { + "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", + "traits": { + "smithy.api#documentation": "

" + } } } }, diff --git a/codegen/sdk/aws-models/location.json b/codegen/sdk/aws-models/location.json index dc68736bd0d..7e0cc2f2bcb 100644 --- a/codegen/sdk/aws-models/location.json +++ b/codegen/sdk/aws-models/location.json @@ -669,7 +669,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the polygon details to specify the position of the geofence.

\n \n

Each geofence polygon can have a maximum of 1,000 vertices.

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

Contains the details of the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Each \n geofence polygon can have a maximum of 1,000 vertices.

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

\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

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

\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

\n ", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -1149,7 +1149,7 @@ "TravelMode": { "target": "com.amazonaws.location#TravelMode", "traits": { - "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed\n of travel and road compatibility.

\n

The TravelMode you specify also determines how you specify route\n preferences:

\n \n

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed\n of travel and road compatibility. You can choose Car, Truck, \n or Walking as options for the TravelMode.

\n

The TravelMode you specify also determines how you specify route\n preferences:

\n \n

Default Value: Car\n

" } }, "DepartureTime": { @@ -1293,6 +1293,29 @@ "smithy.api#documentation": "

Contains details about additional route preferences for requests that specify\n TravelMode as Truck.

" } }, + "com.amazonaws.location#Circle": { + "type": "structure", + "members": { + "Center": { + "target": "com.amazonaws.location#Position", + "traits": { + "smithy.api#documentation": "

A single point geometry, specifying the center of the circle, using WGS 84\n coordinates, in the form [longitude, latitude].

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

The radius of the circle in meters. Must be greater than zero and no \n larger than 100,000 (100 kilometers).

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

A circle on the earth, as defined by a center point and a radius.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.location#ConflictException": { "type": "structure", "members": { @@ -3038,12 +3061,18 @@ "Polygon": { "target": "com.amazonaws.location#LinearRings", "traits": { - "smithy.api#documentation": "

An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices,\n where the first and last vertex are the same to form a closed boundary. Each vertex is a\n 2-dimensional point of the form: [longitude, latitude].

\n

The first linear ring is an outer ring, describing the polygon's boundary. Subsequent\n linear rings may be inner or outer rings to describe holes and islands. Outer rings must\n list their vertices in counter-clockwise order around the ring's center, where the left\n side is the polygon's exterior. Inner rings must list their vertices in clockwise order,\n where the left side is the polygon's interior.

" + "smithy.api#documentation": "

An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices,\n where the first and last vertex are the same to form a closed boundary. Each vertex is a\n 2-dimensional point of the form: [longitude, latitude].

\n

The first linear ring is an outer ring, describing the polygon's boundary. Subsequent\n linear rings may be inner or outer rings to describe holes and islands. Outer rings must\n list their vertices in counter-clockwise order around the ring's center, where the left\n side is the polygon's exterior. Inner rings must list their vertices in clockwise order,\n where the left side is the polygon's interior.

\n

A geofence polygon can consist of between 4 and 1,000 vertices.

" + } + }, + "Circle": { + "target": "com.amazonaws.location#Circle", + "traits": { + "smithy.api#documentation": "

A circle on the earth, as defined by a center point and a radius.

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

Contains the geofence geometry details.

\n \n

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons\n that are wound clockwise, or that cross the antimeridian.

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

Contains the geofence geometry details.

\n

A geofence geometry is made up of either a polygon or a circle. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons\n that are wound clockwise, or that cross the antimeridian.

\n " } }, "com.amazonaws.location#GetDevicePosition": { @@ -3329,7 +3358,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the geofence geometry details describing a polygon.

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

Contains the geofence geometry details describing a polygon or a circle.

", "smithy.api#required": {} } }, @@ -3407,7 +3436,7 @@ "FontStack": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid fonts stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

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

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid fonts stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4162,7 +4191,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the geofence geometry details describing a polygon.

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

Contains the geofence geometry details describing a polygon or a circle.

", "smithy.api#required": {} } }, @@ -5005,7 +5034,7 @@ "name": "geo" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing", + "smithy.api#documentation": "

\"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing\"

", "smithy.api#title": "Amazon Location Service" }, "version": "2020-11-19", @@ -5036,7 +5065,7 @@ "Style": { "target": "com.amazonaws.location#MapStyle", "traits": { - "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

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

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

\n \n \n

The VectorHereContrast style has been renamed from VectorHereBerlin. \n VectorHereBerlin has been deprecated, but will continue to work in \n applications that use it.

\n ", "smithy.api#required": {} } } @@ -5409,7 +5438,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the polygon details to specify the position of the geofence.

\n \n

Each geofence polygon can have a maximum of 1,000 vertices.

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

Contains the details to specify the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Each \n geofence polygon can have a maximum of 1,000 vertices.

\n ", "smithy.api#required": {} } } @@ -6476,7 +6505,7 @@ "Length": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The length of the truck.

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

The length of the truck.

\n \n \n

\n For routes calculated with a HERE resource, this value must be between 0 and 300 meters.\n

\n ", "smithy.api#range": { "min": 0 } @@ -6485,7 +6514,7 @@ "Height": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The height of the truck.

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

The height of the truck.

\n \n \n

\n For routes calculated with a HERE resource, this value must be between 0 and 50 meters.\n

\n ", "smithy.api#range": { "min": 0 } @@ -6494,7 +6523,7 @@ "Width": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The width of the truck.

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

The width of the truck.

\n \n \n

\n For routes calculated with a HERE resource, this value must be between 0 and 50 meters.\n

\n ", "smithy.api#range": { "min": 0 } diff --git a/codegen/sdk/aws-models/networkmanager.json b/codegen/sdk/aws-models/networkmanager.json index 3d4429a5caa..71dbc49159a 100644 --- a/codegen/sdk/aws-models/networkmanager.json +++ b/codegen/sdk/aws-models/networkmanager.json @@ -10063,12 +10063,28 @@ "traits": { "smithy.api#documentation": "

The ARN of the transit gateway.

" } + }, + "TransitGatewayPeeringAttachmentId": { + "target": "com.amazonaws.networkmanager#TransitGatewayPeeringAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

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

Describes a transit gateway peering attachment.

" } }, + "com.amazonaws.networkmanager#TransitGatewayPeeringAttachmentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^tgw-attach-([0-9a-f]{8,17})$" + } + }, "com.amazonaws.networkmanager#TransitGatewayRegistration": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/personalize-runtime.json b/codegen/sdk/aws-models/personalize-runtime.json index 77157277432..7f66a012d81 100644 --- a/codegen/sdk/aws-models/personalize-runtime.json +++ b/codegen/sdk/aws-models/personalize-runtime.json @@ -294,7 +294,7 @@ "filterValues": { "target": "com.amazonaws.personalizeruntime#FilterValues", "traits": { - "smithy.api#documentation": "

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)\n as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.\n

\n

For filter expressions that use an INCLUDE element to include items,\n you must provide values for all parameters that are defined in the expression. For\n filters with expressions that use an EXCLUDE element to exclude items, you\n can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of\n the expression to filter recommendations.

\n

For more information, see\n Filtering Recommendations.

" + "smithy.api#documentation": "

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)\n as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.\n

\n

For filter expressions that use an INCLUDE element to include items,\n you must provide values for all parameters that are defined in the expression. For\n filters with expressions that use an EXCLUDE element to exclude items, you\n can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of\n the expression to filter recommendations.

\n

For more information, see\n Filtering recommendations and user segments.

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

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you\n created a Domain dataset group with a recommender for a domain use case.

" } + }, + "promotions": { + "target": "com.amazonaws.personalizeruntime#PromotionList", + "traits": { + "smithy.api#documentation": "

The promotions to apply to the recommendation request. \n A promotion defines additional business rules that apply to a configurable subset of recommended items.

" + } } } }, @@ -356,6 +362,16 @@ "target": "com.amazonaws.personalizeruntime#PredictedItem" } }, + "com.amazonaws.personalizeruntime#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" + } + }, "com.amazonaws.personalizeruntime#NumResults": { "type": "integer", "traits": { @@ -364,6 +380,15 @@ } } }, + "com.amazonaws.personalizeruntime#PercentPromotedItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.personalizeruntime#PredictedItem": { "type": "structure", "members": { @@ -378,12 +403,62 @@ "traits": { "smithy.api#documentation": "

A numeric representation of the model's certainty that the item will be the next user\n selection. For more information on scoring logic, see how-scores-work.

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

The name of the promotion that included the predicted item.

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

An object that identifies an item.

\n

The and APIs return a list of\n PredictedItems.

" } }, + "com.amazonaws.personalizeruntime#Promotion": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.personalizeruntime#Name", + "traits": { + "smithy.api#documentation": "

The name of the promotion.

" + } + }, + "percentPromotedItems": { + "target": "com.amazonaws.personalizeruntime#PercentPromotedItems", + "traits": { + "smithy.api#documentation": "

The percentage of recommended items to apply the promotion to.

" + } + }, + "filterArn": { + "target": "com.amazonaws.personalizeruntime#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see \n Promotion filters.

" + } + }, + "filterValues": { + "target": "com.amazonaws.personalizeruntime#FilterValues", + "traits": { + "smithy.api#documentation": "

The values to use when promoting items.\n For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma. \n

\n

For filter expressions that use an INCLUDE element to include items,\n you must provide values for all parameters that are defined in the expression. For\n filters with expressions that use an EXCLUDE element to exclude items, you\n can omit the filter-values. In this case, Amazon Personalize doesn't use that portion of\n the expression to filter recommendations.

\n

For more information on creating filters, see\n Filtering recommendations and user segments.

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

Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.

" + } + }, + "com.amazonaws.personalizeruntime#PromotionList": { + "type": "list", + "member": { + "target": "com.amazonaws.personalizeruntime#Promotion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.personalizeruntime#RecommendationID": { "type": "string" }, diff --git a/codegen/sdk/aws-models/pinpoint.json b/codegen/sdk/aws-models/pinpoint.json index 8b5b310e562..72cde4cb2b8 100644 --- a/codegen/sdk/aws-models/pinpoint.json +++ b/codegen/sdk/aws-models/pinpoint.json @@ -2394,6 +2394,70 @@ "smithy.api#documentation": "

Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.

" } }, + "com.amazonaws.pinpoint#ClosedDays": { + "type": "structure", + "members": { + "EMAIL": { + "target": "com.amazonaws.pinpoint#ListOfClosedDaysRules", + "traits": { + "smithy.api#documentation": "

Rules for Email Channel.

" + } + }, + "SMS": { + "target": "com.amazonaws.pinpoint#ListOfClosedDaysRules", + "traits": { + "smithy.api#documentation": "

Rules for SMS Channel.

" + } + }, + "PUSH": { + "target": "com.amazonaws.pinpoint#ListOfClosedDaysRules", + "traits": { + "smithy.api#documentation": "

Rules for Push Channel.

" + } + }, + "VOICE": { + "target": "com.amazonaws.pinpoint#ListOfClosedDaysRules", + "traits": { + "smithy.api#documentation": "

Rules for Voice Channel.

" + } + }, + "CUSTOM": { + "target": "com.amazonaws.pinpoint#ListOfClosedDaysRules", + "traits": { + "smithy.api#documentation": "

Rules for Custom Channel.

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

The time when journey will stop sending messages.

" + } + }, + "com.amazonaws.pinpoint#ClosedDaysRule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

Name of the rule.

" + } + }, + "StartDateTime": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

Start Datetime in ISO 8601 format.

" + } + }, + "EndDateTime": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

End Datetime in ISO 8601 format.

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

Closed Days Rule. Part of Journey sending schedule.

" + } + }, "com.amazonaws.pinpoint#Condition": { "type": "structure", "members": { @@ -3474,6 +3538,41 @@ "smithy.api#documentation": "

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

" } }, + "com.amazonaws.pinpoint#DayOfWeek": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MONDAY", + "name": "MONDAY" + }, + { + "value": "TUESDAY", + "name": "TUESDAY" + }, + { + "value": "WEDNESDAY", + "name": "WEDNESDAY" + }, + { + "value": "THURSDAY", + "name": "THURSDAY" + }, + { + "value": "FRIDAY", + "name": "FRIDAY" + }, + { + "value": "SATURDAY", + "name": "SATURDAY" + }, + { + "value": "SUNDAY", + "name": "SUNDAY" + } + ] + } + }, "com.amazonaws.pinpoint#DefaultButtonConfiguration": { "type": "structure", "members": { @@ -11545,6 +11644,24 @@ "traits": { "smithy.api#documentation": "

The channel-specific configurations for the journey.

" } + }, + "SendingSchedule": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)

" + } + }, + "OpenHours": { + "target": "com.amazonaws.pinpoint#OpenHours", + "traits": { + "smithy.api#documentation": "

The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.

" + } + }, + "ClosedDays": { + "target": "com.amazonaws.pinpoint#ClosedDays", + "traits": { + "smithy.api#documentation": "

The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

" + } } }, "traits": { @@ -11778,6 +11895,15 @@ "target": "com.amazonaws.pinpoint#CampaignResponse" } }, + "com.amazonaws.pinpoint#ListOfClosedDaysRules": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpoint#ClosedDaysRule", + "traits": { + "smithy.api#documentation": "

ClosedDays rule details.

" + } + } + }, "com.amazonaws.pinpoint#ListOfEndpointBatchItem": { "type": "list", "member": { @@ -11826,6 +11952,15 @@ "target": "com.amazonaws.pinpoint#MultiConditionalBranch" } }, + "com.amazonaws.pinpoint#ListOfOpenHoursRules": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpoint#OpenHoursRule", + "traits": { + "smithy.api#documentation": "

Open Hour Rule Details.

" + } + } + }, "com.amazonaws.pinpoint#ListOfRandomSplitEntry": { "type": "list", "member": { @@ -12236,6 +12371,21 @@ "target": "com.amazonaws.pinpoint#ItemResponse" } }, + "com.amazonaws.pinpoint#MapOfListOfOpenHoursRules": { + "type": "map", + "key": { + "target": "com.amazonaws.pinpoint#DayOfWeek", + "traits": { + "smithy.api#documentation": "

Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

" + } + }, + "value": { + "target": "com.amazonaws.pinpoint#ListOfOpenHoursRules", + "traits": { + "smithy.api#documentation": "

Open Hour Rules.

" + } + } + }, "com.amazonaws.pinpoint#MapOfListOf__string": { "type": "map", "key": { @@ -12833,6 +12983,64 @@ "smithy.api#documentation": "

Provides information about a phone number.

" } }, + "com.amazonaws.pinpoint#OpenHours": { + "type": "structure", + "members": { + "EMAIL": { + "target": "com.amazonaws.pinpoint#MapOfListOfOpenHoursRules", + "traits": { + "smithy.api#documentation": "

Rules for Email Channel.

" + } + }, + "SMS": { + "target": "com.amazonaws.pinpoint#MapOfListOfOpenHoursRules", + "traits": { + "smithy.api#documentation": "

Rules for SMS Channel.

" + } + }, + "PUSH": { + "target": "com.amazonaws.pinpoint#MapOfListOfOpenHoursRules", + "traits": { + "smithy.api#documentation": "

Rules for Push Channel.

" + } + }, + "VOICE": { + "target": "com.amazonaws.pinpoint#MapOfListOfOpenHoursRules", + "traits": { + "smithy.api#documentation": "

Rules for Voice Channel.

" + } + }, + "CUSTOM": { + "target": "com.amazonaws.pinpoint#MapOfListOfOpenHoursRules", + "traits": { + "smithy.api#documentation": "

Rules for Custom Channel.

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

The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.

" + } + }, + "com.amazonaws.pinpoint#OpenHoursRule": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

Local start time in ISO 8601 format.

" + } + }, + "EndTime": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

Local start time in ISO 8601 format.

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

List of OpenHours Rules.

" + } + }, "com.amazonaws.pinpoint#Operator": { "type": "string", "traits": { @@ -15401,6 +15609,9 @@ "input": { "target": "com.amazonaws.pinpoint#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

", "smithy.api#http": { @@ -15850,6 +16061,9 @@ "input": { "target": "com.amazonaws.pinpoint#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

", "smithy.api#http": { @@ -18475,6 +18689,24 @@ "traits": { "smithy.api#documentation": "

The channel-specific configurations for the journey.

" } + }, + "SendingSchedule": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)

" + } + }, + "OpenHours": { + "target": "com.amazonaws.pinpoint#OpenHours", + "traits": { + "smithy.api#documentation": "

The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.

" + } + }, + "ClosedDays": { + "target": "com.amazonaws.pinpoint#ClosedDays", + "traits": { + "smithy.api#documentation": "

The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/privatenetworks.json b/codegen/sdk/aws-models/privatenetworks.json new file mode 100644 index 00000000000..1f4ca527ec3 --- /dev/null +++ b/codegen/sdk/aws-models/privatenetworks.json @@ -0,0 +1,3040 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.privatenetworks#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have permission to perform this operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.privatenetworks#AcknowledgeOrderReceipt": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Acknowledges that the specified network order was received.

", + "smithy.api#http": { + "uri": "/v1/orders/acknowledge", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptRequest": { + "type": "structure", + "members": { + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptResponse": { + "type": "structure", + "members": { + "order": { + "target": "com.amazonaws.privatenetworks#Order", + "traits": { + "smithy.api#documentation": "

Information about the order.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#AcknowledgmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACKNOWLEDGING", + "name": "ACKNOWLEDGING" + }, + { + "value": "ACKNOWLEDGED", + "name": "ACKNOWLEDGED" + }, + { + "value": "UNACKNOWLEDGED", + "name": "UNACKNOWLEDGED" + } + ] + } + }, + "com.amazonaws.privatenetworks#ActivateDeviceIdentifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifierRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates the specified device identifier.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/activate", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#ActivateDeviceIdentifierRequest": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ActivateDeviceIdentifierResponse": { + "type": "structure", + "members": { + "deviceIdentifier": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier", + "traits": { + "smithy.api#documentation": "

Information about the device identifier.

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

\n The tags on the device identifier. \n

" + } + } + } + }, + "com.amazonaws.privatenetworks#ActivateNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ActivateNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ActivateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates the specified network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/activate", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#ActivateNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#required": {} + } + }, + "shippingAddress": { + "target": "com.amazonaws.privatenetworks#Address", + "traits": { + "smithy.api#documentation": "

The shipping address of the network site.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ActivateNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Address": { + "type": "structure", + "members": { + "city": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The city for this address.

", + "smithy.api#required": {} + } + }, + "company": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The company name for this address.

" + } + }, + "country": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The country for this address.

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

The recipient's name for this address.

", + "smithy.api#required": {} + } + }, + "phoneNumber": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The phone number for this address.

" + } + }, + "postalCode": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The postal code for this address.

", + "smithy.api#required": {} + } + }, + "stateOrProvince": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The state or province for this address.

", + "smithy.api#required": {} + } + }, + "street1": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The first line of the street address.

", + "smithy.api#required": {} + } + }, + "street2": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The second line of the street address.

" + } + }, + "street3": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The third line of the street address.

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

Information about an address.

" + } + }, + "com.amazonaws.privatenetworks#AddressContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$" + } + }, + "com.amazonaws.privatenetworks#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.privatenetworks#ConfigureAccessPoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ConfigureAccessPointRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ConfigureAccessPointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Configures the specified network resource. \n

\n

\n Use this action to specify the geographic\n position of the hardware. You must provide Certified Professional Installer (CPI)\n credentials in the request so that we can obtain spectrum grants. For more information,\n see Radio\n units in the Amazon Web Services Private 5G User Guide.

", + "smithy.api#http": { + "uri": "/v1/network-resources/configure", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#ConfigureAccessPointRequest": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

", + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.privatenetworks#Position", + "traits": { + "smithy.api#documentation": "

The position of the network resource.

" + } + }, + "cpiUsername": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The CPI user name of the CPI user who is certifying the coordinates of the radio\n unit.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "cpiUserId": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "cpiUserPassword": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The CPI password associated with the CPI certificate in\n cpiSecretKey.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "cpiSecretKey": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

A Base64 encoded string of the CPI certificate associated with the CPI user who is\n certifying the coordinates of the network resource.

", + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ConfigureAccessPointResponse": { + "type": "structure", + "members": { + "accessPoint": { + "target": "com.amazonaws.privatenetworks#NetworkResource", + "traits": { + "smithy.api#documentation": "

Information about the network resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#CreateNetworkRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#CreateNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#LimitExceededException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a network.

", + "smithy.api#http": { + "uri": "/v1/networks", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#CreateNetworkRequest": { + "type": "structure", + "members": { + "networkName": { + "target": "com.amazonaws.privatenetworks#Name", + "traits": { + "smithy.api#documentation": "

The name of the network. You can't change the name after you create the network.

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

The description of the network.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags to apply to the network.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetworkResponse": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.privatenetworks#Network", + "traits": { + "smithy.api#documentation": "

Information about the network.

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

\n The network tags. \n

" + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#CreateNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#CreateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#CreateNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteName": { + "target": "com.amazonaws.privatenetworks#Name", + "traits": { + "smithy.api#documentation": "

The name of the site. You can't change the name after you create the site.

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

The description of the site.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "pendingPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

Information about the pending plan for this site.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

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

The Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

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

The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags to apply to the network site.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network site tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#DeactivateDeviceIdentifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deactivates the specified device identifier.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/deactivate", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierRequest": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierResponse": { + "type": "structure", + "members": { + "deviceIdentifier": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier", + "traits": { + "smithy.api#documentation": "

Information about the device identifier.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified network. You must delete network sites before you delete the\n network. For more information, see \n DeleteNetworkSite in the \n API Reference for Amazon Web Services Private 5G.

", + "smithy.api#http": { + "uri": "/v1/networks/{networkArn}", + "method": "DELETE", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkRequest": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", + "smithy.api#httpQuery": "clientToken" + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkResponse": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.privatenetworks#Network", + "traits": { + "smithy.api#documentation": "

Information about the network.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified network site. Return the hardware after you delete the network\n site. You are responsible for minimum charges. For more information, see Hardware\n returns in the Amazon Web Services Private 5G User\n Guide.

", + "smithy.api#http": { + "uri": "/v1/network-sites/{networkSiteArn}", + "method": "DELETE", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", + "smithy.api#httpQuery": "clientToken" + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifier": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

" + } + }, + "trafficGroupArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which the device identifier appears.

" + } + }, + "imsi": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The International Mobile Subscriber Identity of the device identifier.

", + "smithy.api#pattern": "^[0-9]{15}$" + } + }, + "iccid": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Integrated Circuit Card Identifier of the device identifier.

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

The vendor of the device identifier.

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

The status of the device identifier.

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

The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

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

The creation time of this device identifier.

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

Information about a subscriber of a device that can use a network.

" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + }, + { + "name": "ORDER", + "value": "ORDER" + }, + { + "name": "TRAFFIC_GROUP", + "value": "TRAFFIC_GROUP" + } + ] + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilterValues" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.privatenetworks#E5GNetworkControllerLambda": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "PrivateNetworks", + "arnNamespace": "private-networks" + }, + "aws.auth#sigv4": { + "name": "private-networks" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale\n your own private mobile network at your on-premises location. Private 5G provides the\n pre-configured hardware and software for mobile networks, helps automate setup, and\n scales capacity on demand to support additional devices as needed.

", + "smithy.api#title": "AWS Private 5G" + }, + "version": "2021-12-03", + "operations": [ + { + "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceipt" + }, + { + "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifier" + }, + { + "target": "com.amazonaws.privatenetworks#ActivateNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#ConfigureAccessPoint" + }, + { + "target": "com.amazonaws.privatenetworks#CreateNetwork" + }, + { + "target": "com.amazonaws.privatenetworks#CreateNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifier" + }, + { + "target": "com.amazonaws.privatenetworks#DeleteNetwork" + }, + { + "target": "com.amazonaws.privatenetworks#DeleteNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#GetDeviceIdentifier" + }, + { + "target": "com.amazonaws.privatenetworks#GetNetwork" + }, + { + "target": "com.amazonaws.privatenetworks#GetNetworkResource" + }, + { + "target": "com.amazonaws.privatenetworks#GetNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#GetOrder" + }, + { + "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiers" + }, + { + "target": "com.amazonaws.privatenetworks#ListNetworkResources" + }, + { + "target": "com.amazonaws.privatenetworks#ListNetworks" + }, + { + "target": "com.amazonaws.privatenetworks#ListNetworkSites" + }, + { + "target": "com.amazonaws.privatenetworks#ListOrders" + }, + { + "target": "com.amazonaws.privatenetworks#ListTagsForResource" + }, + { + "target": "com.amazonaws.privatenetworks#Ping" + }, + { + "target": "com.amazonaws.privatenetworks#TagResource" + }, + { + "target": "com.amazonaws.privatenetworks#UntagResource" + }, + { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSitePlan" + } + ] + }, + "com.amazonaws.privatenetworks#ElevationReference": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGL", + "name": "AGL" + }, + { + "value": "AMSL", + "name": "AMSL" + } + ] + } + }, + "com.amazonaws.privatenetworks#ElevationUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FEET", + "name": "FEET", + "documentation": "Feet." + } + ] + } + }, + "com.amazonaws.privatenetworks#GetDeviceIdentifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetDeviceIdentifierRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetDeviceIdentifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified device identifier.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/{deviceIdentifierArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetDeviceIdentifierRequest": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetDeviceIdentifierResponse": { + "type": "structure", + "members": { + "deviceIdentifier": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier", + "traits": { + "smithy.api#documentation": "

Information about the device identifier.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The device identifier tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified network.

", + "smithy.api#http": { + "uri": "/v1/networks/{networkArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetNetworkRequest": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetNetworkResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetNetworkResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified network resource.

", + "smithy.api#http": { + "uri": "/v1/network-resources/{networkResourceArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetNetworkResourceRequest": { + "type": "structure", + "members": { + "networkResourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkResourceResponse": { + "type": "structure", + "members": { + "networkResource": { + "target": "com.amazonaws.privatenetworks#NetworkResource", + "traits": { + "smithy.api#documentation": "

Information about the network resource.

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

\n The network resource tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkResponse": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.privatenetworks#Network", + "traits": { + "smithy.api#documentation": "

Information about the network.

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

\n The network tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/{networkSiteArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network site tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetOrder": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetOrderRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetOrderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified order.

", + "smithy.api#http": { + "uri": "/v1/orders/{orderArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetOrderRequest": { + "type": "structure", + "members": { + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetOrderResponse": { + "type": "structure", + "members": { + "order": { + "target": "com.amazonaws.privatenetworks#Order", + "traits": { + "smithy.api#documentation": "

Information about the order.

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

\n The order tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#HealthStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INITIAL", + "name": "INITIAL" + }, + { + "value": "HEALTHY", + "name": "HEALTHY" + }, + { + "value": "UNHEALTHY", + "name": "UNHEALTHY" + } + ] + } + }, + "com.amazonaws.privatenetworks#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.", + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Advice to clients on when the call can be safely retried.", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an internal error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.privatenetworks#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The limit was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.privatenetworks#ListDeviceIdentifiers": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiersRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists device identifiers. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, \n the status of device identifiers, or the ARN of the traffic group.

\n \n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "deviceIdentifiers" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListDeviceIdentifiersRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListDeviceIdentifiersResponse": { + "type": "structure", + "members": { + "deviceIdentifiers": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierList", + "traits": { + "smithy.api#documentation": "

Information about the device identifiers.

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

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListNetworkResourcesRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListNetworkResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists network resources. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or \n the status of network resources.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", + "smithy.api#http": { + "uri": "/v1/network-resources", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networkResources" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListNetworkResourcesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#NetworkResourceFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkResourcesResponse": { + "type": "structure", + "members": { + "networkResources": { + "target": "com.amazonaws.privatenetworks#NetworkResourceList", + "traits": { + "smithy.api#documentation": "

Information about network resources.

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

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkSites": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListNetworkSitesRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListNetworkSitesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists network sites. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networkSites" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListNetworkSitesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#NetworkSiteFilters", + "traits": { + "smithy.api#documentation": "

The filters. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network sites.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkSitesResponse": { + "type": "structure", + "members": { + "networkSites": { + "target": "com.amazonaws.privatenetworks#NetworkSiteList", + "traits": { + "smithy.api#documentation": "

Information about the network sites.

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

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListNetworksRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListNetworksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists networks. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network.

", + "smithy.api#http": { + "uri": "/v1/networks/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networks" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListNetworksRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#NetworkFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworksResponse": { + "type": "structure", + "members": { + "networks": { + "target": "com.amazonaws.privatenetworks#NetworkList", + "traits": { + "smithy.api#documentation": "

The networks.

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

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListOrders": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListOrdersRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListOrdersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists orders. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or \n the status of the order.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", + "smithy.api#http": { + "uri": "/v1/orders/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "orders" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListOrdersRequest": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "filters": { + "target": "com.amazonaws.privatenetworks#OrderFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListOrdersResponse": { + "type": "structure", + "members": { + "orders": { + "target": "com.amazonaws.privatenetworks#OrderList", + "traits": { + "smithy.api#documentation": "

Information about the orders.

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

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#AccessDeniedException" + }, + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ThrottlingException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for the specified resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

The resource tags.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-]*$" + } + }, + "com.amazonaws.privatenetworks#NameValuePair": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the pair.

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

The value of the pair.

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

Information about a name/value pair.

" + } + }, + "com.amazonaws.privatenetworks#NameValuePairs": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NameValuePair" + } + }, + "com.amazonaws.privatenetworks#Network": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

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

The name of the network.

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

The description of the network.

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

The status of the network.

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

The status reason of the network.

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

The creation time of the network.

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

Information about a network.

" + } + }, + "com.amazonaws.privatenetworks#NetworkFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#NetworkFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#NetworkFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#NetworkFilterValues" + } + }, + "com.amazonaws.privatenetworks#NetworkList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#Network" + } + }, + "com.amazonaws.privatenetworks#NetworkResource": { + "type": "structure", + "members": { + "networkResourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

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

The description of the network resource.

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

The type of the network resource.

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

The status of the network resource.

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

The status reason of the network resource.

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

The vendor of the network resource.

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

The model of the network resource.

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

The serial number of the network resource.

" + } + }, + "health": { + "target": "com.amazonaws.privatenetworks#HealthStatus", + "traits": { + "smithy.api#documentation": "

The health of the network resource.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which this network resource appears.

" + } + }, + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site on which this network resource\n appears.

" + } + }, + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase this network resource.

" + } + }, + "attributes": { + "target": "com.amazonaws.privatenetworks#NameValuePairs", + "traits": { + "smithy.api#documentation": "

The attributes of the network resource.

" + } + }, + "position": { + "target": "com.amazonaws.privatenetworks#Position", + "traits": { + "smithy.api#documentation": "

The position of the network resource.

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

The creation time of the network resource.

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

Information about a network resource.

" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceDefinition": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitionType", + "traits": { + "smithy.api#documentation": "

The type in the network resource definition.

", + "smithy.api#required": {} + } + }, + "options": { + "target": "com.amazonaws.privatenetworks#Options", + "traits": { + "smithy.api#documentation": "

The options in the network resource definition.

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

The count in the network resource definition.

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

Information about a network resource definition.

" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceDefinitionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RADIO_UNIT", + "name": "RADIO_UNIT" + }, + { + "value": "DEVICE_IDENTIFIER", + "name": "DEVICE_IDENTIFIER" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkResourceDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinition" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ORDER", + "value": "ORDER" + }, + { + "name": "STATUS", + "value": "STATUS" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkResourceFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#NetworkResourceFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#NetworkResourceFilterValues" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NetworkResource" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SHIPPED", + "name": "SHIPPED" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "PROVISIONED", + "name": "PROVISIONED" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "PENDING_RETURN", + "name": "PENDING_RETURN" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RADIO_UNIT", + "name": "RADIO_UNIT" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkSite": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

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

The name of the network site.

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

The description of the network site.

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

The status of the network site.

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

The status reason of the network site.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network to which the network site belongs.

", + "smithy.api#required": {} + } + }, + "pendingPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

The pending plan of the network site.

" + } + }, + "currentPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

The current plan of the network site.

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

The creation time of the network site.

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

\n The parent Availability Zone for the network site.\n

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

\n The parent Availability Zone ID for the network site.\n

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

Information about a network site.

" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkSiteFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#NetworkSiteFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#NetworkSiteFilterValues" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NetworkSite" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DEPROVISIONING", + "name": "DEPROVISIONING" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DEPROVISIONING", + "name": "DEPROVISIONING" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.privatenetworks#Options": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NameValuePair" + } + }, + "com.amazonaws.privatenetworks#Order": { + "type": "structure", + "members": { + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

" + } + }, + "shippingAddress": { + "target": "com.amazonaws.privatenetworks#Address", + "traits": { + "smithy.api#documentation": "

The shipping address of the order.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network associated with this order.

" + } + }, + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site associated with this order.

" + } + }, + "trackingInformation": { + "target": "com.amazonaws.privatenetworks#TrackingInformationList", + "traits": { + "smithy.api#documentation": "

The tracking information of the order.

" + } + }, + "acknowledgmentStatus": { + "target": "com.amazonaws.privatenetworks#AcknowledgmentStatus", + "traits": { + "smithy.api#documentation": "

The acknowledgement status of the order.

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

The creation time of the order.

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

Information about an order.

" + } + }, + "com.amazonaws.privatenetworks#OrderFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + }, + { + "name": "NETWORK_SITE", + "value": "NETWORK_SITE" + } + ] + } + }, + "com.amazonaws.privatenetworks#OrderFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#OrderFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#OrderFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#OrderFilterValues" + } + }, + "com.amazonaws.privatenetworks#OrderList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#Order" + } + }, + "com.amazonaws.privatenetworks#PaginationToken": { + "type": "string" + }, + "com.amazonaws.privatenetworks#Ping": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.privatenetworks#PingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Checks the health of the service.

", + "smithy.api#http": { + "uri": "/ping", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#PingResponse": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Information about the health of the service.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Position": { + "type": "structure", + "members": { + "latitude": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The latitude of the position.

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

The longitude of the position.

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

The elevation of the equipment at this position.

" + } + }, + "elevationUnit": { + "target": "com.amazonaws.privatenetworks#ElevationUnit", + "traits": { + "smithy.api#documentation": "

The units used to measure the elevation of the position.

" + } + }, + "elevationReference": { + "target": "com.amazonaws.privatenetworks#ElevationReference", + "traits": { + "smithy.api#documentation": "

The reference point from which elevation is reported.

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

Information about a position.

" + } + }, + "com.amazonaws.privatenetworks#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifier of the affected resource.", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of the affected resource.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.privatenetworks#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#SitePlan": { + "type": "structure", + "members": { + "resourceDefinitions": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitions", + "traits": { + "smithy.api#documentation": "

The resource definitions of the plan.

" + } + }, + "options": { + "target": "com.amazonaws.privatenetworks#Options", + "traits": { + "smithy.api#documentation": "

The options of the plan.

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

Information about a site plan.

" + } + }, + "com.amazonaws.privatenetworks#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[^\\x00-\\x1f\\x22]+$" + } + }, + "com.amazonaws.privatenetworks#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#TagKey" + }, + "value": { + "target": "com.amazonaws.privatenetworks#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#AccessDeniedException" + }, + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ThrottlingException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Adds tags to the specified resource.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.privatenetworks#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.privatenetworks#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[^\\x00-\\x1f\\x22]*$" + } + }, + "com.amazonaws.privatenetworks#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

\n The request was denied due to request throttling.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.privatenetworks#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.privatenetworks#TrackingInformation": { + "type": "structure", + "members": { + "trackingNumber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The tracking number of the shipment.

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

Information about tracking a shipment.

" + } + }, + "com.amazonaws.privatenetworks#TrackingInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#TrackingInformation" + } + }, + "com.amazonaws.privatenetworks#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#AccessDeniedException" + }, + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ThrottlingException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from the specified resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.privatenetworks#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.privatenetworks#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.privatenetworks#UpdateNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/site", + "method": "PUT", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSitePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSitePlanRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified network site plan.

", + "smithy.api#http": { + "uri": "/v1/network-sites/plan", + "method": "PUT", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSitePlanRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#required": {} + } + }, + "pendingPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

The pending plan.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

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

The description.

" + } + } + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network site tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.privatenetworks#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "Reason the request failed validation.", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.privatenetworks#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The list of fields that caused the error, if applicable." + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed validation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.privatenetworks#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The field name that failed validation.

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

The message about the validation failure.

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

Information about a field that failed validation.

" + } + }, + "com.amazonaws.privatenetworks#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#ValidationExceptionField" + } + }, + "com.amazonaws.privatenetworks#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "CANNOT_ASSUME_ROLE", + "name": "CANNOT_ASSUME_ROLE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index 41c36913472..69a66718a76 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -2474,7 +2474,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight group.

\n\t\t

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n\t\t

The response is a group object.

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

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.

\n\t\t

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n\t\t

The response is a group object.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", @@ -9490,7 +9490,7 @@ "AuthorizedResourceArns": { "target": "com.amazonaws.quicksight#ArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.

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

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session. If you choose\n Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view. Currently, you can pass up to 25\n dashboard ARNs in each API call.

", "smithy.api#required": {} } }, @@ -9504,7 +9504,7 @@ "AllowedDomains": { "target": "com.amazonaws.quicksight#StringList", "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console and instead allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

\n

To include a subdomain, use * to include all subdomains under a specific domain to the allow list. For example, https://*.sapp.amazon.com, includes all subdomains under https://sapp.amazon.com.

" + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that\n is then embedded. This optional parameter overrides the static domains that are\n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it\n allows only the domains that you include in this parameter. You can list up to three\n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" } } } @@ -9616,7 +9616,7 @@ "AllowedDomains": { "target": "com.amazonaws.quicksight#StringList", "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console and instead allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

\n

To include a subdomain, use * to include all subdomains under a specific domain to the allow list. For example, https://*.sapp.amazon.com, includes all subdomains under https://sapp.amazon.com.

" + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

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

Generates a temporary session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n \n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

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

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n \n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", @@ -12315,7 +12315,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the namespaces for the specified Amazon Web Services account.

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

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces", @@ -12343,7 +12343,7 @@ "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

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

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

", "smithy.api#httpQuery": "next-token" } }, @@ -12369,7 +12369,7 @@ "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

" } }, "RequestId": { diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index 9f4cdc72b50..9065fcc3896 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -965,7 +965,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n \n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n \n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

" + "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { @@ -2341,6 +2341,12 @@ }, "ServerlessV2ScalingConfiguration": { "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

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

Creates a new DB security group. DB security groups control access to a DB instance.

\n \n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

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

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#CreateDBSecurityGroupMessage": { @@ -3642,7 +3648,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n \n

RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.

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

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { @@ -4371,6 +4377,12 @@ }, "ServerlessV2ScalingConfiguration": { "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

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

Deletes a DB security group.

\n \n

The specified DB security group must not be associated with any DB instances.

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

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { @@ -10196,7 +10208,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

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

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13855,6 +13867,12 @@ }, "ServerlessV2ScalingConfiguration": { "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } } }, "traits": { @@ -14069,7 +14087,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.

\n

This setting doesn't apply to RDS Custom for Oracle.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon\n RDS User Guide. For RDS Custom, see DB instance class support\n for RDS Custom for Oracle and DB instance class\n support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.

\n

Default: Uses existing setting

" } }, "DBSubnetGroupName": { @@ -17601,6 +17619,12 @@ }, "ServerlessV2ScalingConfiguration": { "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + } } } }, @@ -17841,6 +17865,12 @@ }, "ServerlessV2ScalingConfiguration": { "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } } }, "traits": { @@ -18077,6 +18107,12 @@ }, "ServerlessV2ScalingConfiguration": { "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

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

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

" + "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { diff --git a/codegen/sdk/aws-models/rekognition.json b/codegen/sdk/aws-models/rekognition.json index b1ba5b9e9ca..77993b7c945 100644 --- a/codegen/sdk/aws-models/rekognition.json +++ b/codegen/sdk/aws-models/rekognition.json @@ -770,6 +770,110 @@ ] } }, + "com.amazonaws.rekognition#CopyProjectVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#CopyProjectVersionRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#CopyProjectVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#LimitExceededException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceInUseException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n

\n

To copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.

\n \n \n

For more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

\n \n

To copy a model, the destination project, source project, and source model version must already exist.

\n \n \n

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.

" + } + }, + "com.amazonaws.rekognition#CopyProjectVersionRequest": { + "type": "structure", + "members": { + "SourceProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", + "traits": { + "smithy.api#documentation": "

The ARN of the source project in the trusting AWS account.

", + "smithy.api#required": {} + } + }, + "SourceProjectVersionArn": { + "target": "com.amazonaws.rekognition#ProjectVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model version in the source project that you want to copy to a destination project.

", + "smithy.api#required": {} + } + }, + "DestinationProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", + "traits": { + "smithy.api#documentation": "

The ARN of the project in the trusted AWS account that you want to copy the model version to.

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

A name for the version of the model that's copied to the destination project.

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

The S3 bucket and folder location where the training output for the source model version is placed.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rekognition#TagMap", + "traits": { + "smithy.api#documentation": "

The key-value tags to assign to the model version.

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

The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).

\n

If you choose to use your own KMS key, you need the following permissions on the KMS key.

\n \n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" + } + } + } + }, + "com.amazonaws.rekognition#CopyProjectVersionResponse": { + "type": "structure", + "members": { + "ProjectVersionArn": { + "target": "com.amazonaws.rekognition#ProjectVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the copied model version in the destination project.

" + } + } + } + }, "com.amazonaws.rekognition#CoversBodyPart": { "type": "structure", "members": { @@ -1788,9 +1892,73 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated \n with the project. To delete a model, see DeleteProjectVersion.

\n

\n DeleteProject is an asynchronous operation. To check if the project is deleted,\n call DescribeProjects. The project is deleted when the project no longer appears in the\n response.

\n

This operation requires permissions to perform the\n rekognition:DeleteProject action.

" + "smithy.api#documentation": "

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated \n with the project. To delete a model, see DeleteProjectVersion.

\n

\n DeleteProject is an asynchronous operation. To check if the project is\n deleted, call DescribeProjects. The project is deleted when the project\n no longer appears in the response. Be aware that deleting a given project will also delete\n any ProjectPolicies associated with that project.

\n

This operation requires permissions to perform the\n rekognition:DeleteProject action.

" + } + }, + "com.amazonaws.rekognition#DeleteProjectPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#DeleteProjectPolicyRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#DeleteProjectPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#InvalidPolicyRevisionIdException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing project policy.

\n

To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.

" + } + }, + "com.amazonaws.rekognition#DeleteProjectPolicyRequest": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project that the project policy you want to delete is attached to.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.rekognition#ProjectPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy that you want to delete.

", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.rekognition#ProjectPolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The ID of the project policy revision that you want to delete.

" + } + } } }, + "com.amazonaws.rekognition#DeleteProjectPolicyResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.rekognition#DeleteProjectRequest": { "type": "structure", "members": { @@ -4991,6 +5159,27 @@ "smithy.api#error": "client" } }, + "com.amazonaws.rekognition#InvalidPolicyRevisionIdException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.rekognition#String" + }, + "Code": { + "target": "com.amazonaws.rekognition#String" + }, + "Logref": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

A universally unique identifier (UUID) for the request.

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

The supplied revision id for the project policy is invalid.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.rekognition#InvalidS3ObjectException": { "type": "structure", "members": { @@ -5804,6 +5993,98 @@ } } }, + "com.amazonaws.rekognition#ListProjectPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#ListProjectPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#ListProjectPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the project policies attached to a project.

\n

To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProjectPolicies", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.rekognition#ListProjectPoliciesPageSize": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.rekognition#ListProjectPoliciesRequest": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", + "traits": { + "smithy.api#documentation": "

The ARN of the project for which you want to list the project policies.

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

If the previous response was incomplete (because there is more results to retrieve),\n Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token\n to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.rekognition#ListProjectPoliciesPageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per paginated call. The largest value you can\n specify is 5. If you specify a value greater than 5, a ValidationException error\n occurs. The default value is 5.

" + } + } + } + }, + "com.amazonaws.rekognition#ListProjectPoliciesResponse": { + "type": "structure", + "members": { + "ProjectPolicies": { + "target": "com.amazonaws.rekognition#ProjectPolicies", + "traits": { + "smithy.api#documentation": "

A list of project policies attached to the project.

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

If the response is truncated, Amazon Rekognition returns this token that you can use in the\n subsequent request to retrieve the next set of project policies.

" + } + } + } + }, "com.amazonaws.rekognition#ListStreamProcessors": { "type": "operation", "input": { @@ -5930,6 +6211,27 @@ } } }, + "com.amazonaws.rekognition#MalformedPolicyDocumentException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.rekognition#String" + }, + "Code": { + "target": "com.amazonaws.rekognition#String" + }, + "Logref": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

A universally unique identifier (UUID) for the request.

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

The format of the project policy document that you supplied to \n PutProjectPolicy is incorrect.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.rekognition#MaxDurationInSecondsULong": { "type": "long", "traits": { @@ -6398,6 +6700,86 @@ } } }, + "com.amazonaws.rekognition#ProjectPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#ProjectPolicy" + } + }, + "com.amazonaws.rekognition#ProjectPolicy": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project to which the project policy is attached.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.rekognition#ProjectPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the project policy.

" + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.rekognition#ProjectPolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID of the project policy.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.rekognition#ProjectPolicyDocument", + "traits": { + "smithy.api#documentation": "

The JSON document for the project policy.

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.rekognition#DateTime", + "traits": { + "smithy.api#documentation": "

The Unix datetime for the creation of the project policy.

" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.rekognition#DateTime", + "traits": { + "smithy.api#documentation": "

The Unix datetime for when the project policy was last updated.

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

Describes a project policy in the response from ListProjectPolicies.

\n\n

" + } + }, + "com.amazonaws.rekognition#ProjectPolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.rekognition#ProjectPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.\\-]+$" + } + }, + "com.amazonaws.rekognition#ProjectPolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Fa-f]+$" + } + }, "com.amazonaws.rekognition#ProjectStatus": { "type": "string", "traits": { @@ -6513,6 +6895,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model.\n For more information, see StartProjectVersion.

" } + }, + "SourceProjectVersionArn": { + "target": "com.amazonaws.rekognition#ProjectVersionArn", + "traits": { + "smithy.api#documentation": "

If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.

" + } } }, "traits": { @@ -6564,6 +6952,18 @@ { "value": "DELETING", "name": "DELETING" + }, + { + "value": "COPYING_IN_PROGRESS", + "name": "COPYING_IN_PROGRESS" + }, + { + "value": "COPYING_COMPLETED", + "name": "COPYING_COMPLETED" + }, + { + "value": "COPYING_FAILED", + "name": "COPYING_FAILED" } ] } @@ -6752,6 +7152,96 @@ "smithy.api#error": "client" } }, + "com.amazonaws.rekognition#PutProjectPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#PutProjectPolicyRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#PutProjectPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#InvalidPolicyRevisionIdException" + }, + { + "target": "com.amazonaws.rekognition#LimitExceededException" + }, + { + "target": "com.amazonaws.rekognition#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.

\n \n \n

For more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n \n

The response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.

\n

To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.

\n \n

You copy a model version by calling CopyProjectVersion.

" + } + }, + "com.amazonaws.rekognition#PutProjectPolicyRequest": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project that the project policy is attached to.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.rekognition#ProjectPolicyName", + "traits": { + "smithy.api#documentation": "

A name for the policy.

", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.rekognition#ProjectPolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels\n generates and assigns a new PolicyRevisionId and then deletes the previous version of the\n policy.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.rekognition#ProjectPolicyDocument", + "traits": { + "smithy.api#documentation": "

A resource policy to add to the model. The policy is a JSON structure that contains\n one or more statements that define the policy. \n The policy must follow the IAM syntax. For\n more information about the contents of a JSON policy document, see \n IAM JSON policy reference.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rekognition#PutProjectPolicyResponse": { + "type": "structure", + "members": { + "PolicyRevisionId": { + "target": "com.amazonaws.rekognition#ProjectPolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The ID of the project policy.

" + } + } + } + }, "com.amazonaws.rekognition#QualityFilter": { "type": "string", "traits": { @@ -6949,7 +7439,7 @@ "name": "rekognition" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the API Reference for Amazon Rekognition Image, \n Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored Video, \n Amazon Rekognition Streaming Video.\n It provides descriptions of actions, data types, common parameters,\n and common errors.

\n\n

\n Amazon Rekognition Image \n

\n\n \n\n \n \n \n

\n Amazon Rekognition Custom Labels \n

\n \n\n \n

\n Amazon Rekognition Video Stored Video \n

\n\n \n \n

\n Amazon Rekognition Video Streaming Video \n

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

This is the API Reference for Amazon Rekognition Image, \n Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored Video, \n Amazon Rekognition Streaming Video.\n It provides descriptions of actions, data types, common parameters,\n and common errors.

\n\n

\n Amazon Rekognition Image \n

\n\n \n\n \n \n \n

\n Amazon Rekognition Custom Labels \n

\n \n\n \n

\n Amazon Rekognition Video Stored Video \n

\n\n \n \n

\n Amazon Rekognition Video Streaming Video \n

\n\n ", "smithy.api#title": "Amazon Rekognition" }, "version": "2016-06-27", @@ -6957,6 +7447,9 @@ { "target": "com.amazonaws.rekognition#CompareFaces" }, + { + "target": "com.amazonaws.rekognition#CopyProjectVersion" + }, { "target": "com.amazonaws.rekognition#CreateCollection" }, @@ -6984,6 +7477,9 @@ { "target": "com.amazonaws.rekognition#DeleteProject" }, + { + "target": "com.amazonaws.rekognition#DeleteProjectPolicy" + }, { "target": "com.amazonaws.rekognition#DeleteProjectVersion" }, @@ -7068,12 +7564,18 @@ { "target": "com.amazonaws.rekognition#ListFaces" }, + { + "target": "com.amazonaws.rekognition#ListProjectPolicies" + }, { "target": "com.amazonaws.rekognition#ListStreamProcessors" }, { "target": "com.amazonaws.rekognition#ListTagsForResource" }, + { + "target": "com.amazonaws.rekognition#PutProjectPolicy" + }, { "target": "com.amazonaws.rekognition#RecognizeCelebrities" }, diff --git a/codegen/sdk/aws-models/sagemaker-a2i-runtime.json b/codegen/sdk/aws-models/sagemaker-a2i-runtime.json index 0e3d90f2d53..7adca7a3e84 100644 --- a/codegen/sdk/aws-models/sagemaker-a2i-runtime.json +++ b/codegen/sdk/aws-models/sagemaker-a2i-runtime.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.sagemakera2iruntime#AmazonSageMakerA2IRuntime": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SageMaker A2I Runtime", + "arnNamespace": "sagemaker", + "cloudFormationName": "SageMakerA2IRuntime", + "cloudTrailEventSource": "sagemakera2iruntime.amazonaws.com", + "endpointPrefix": "a2i-runtime.sagemaker" + }, + "aws.auth#sigv4": { + "name": "sagemaker" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning\n application. When an AI application can't evaluate data with a high degree of confidence,\n human reviewers can take over. This human review is called a human review workflow. To create\n and start a human review workflow, you need three resources: a worker task\n template, a flow definition, and a human\n loop.

\n

For information about these resources and prerequisites for using Amazon A2I, see Get Started with\n Amazon Augmented AI in the Amazon SageMaker Developer Guide.

\n

This API reference includes information about API actions and data types that you can use\n to interact with Amazon A2I programmatically. Use this guide to:

\n \n

Amazon A2I integrates APIs from various AWS services to create and start human review\n workflows for those services. To learn how Amazon A2I uses these APIs, see Use APIs in\n Amazon A2I in the Amazon SageMaker Developer Guide.

", + "smithy.api#title": "Amazon Augmented AI Runtime" + }, "version": "2019-11-07", "operations": [ { @@ -48,22 +63,7 @@ { "target": "com.amazonaws.sagemakera2iruntime#StopHumanLoop" } - ], - "traits": { - "aws.api#service": { - "sdkId": "SageMaker A2I Runtime", - "arnNamespace": "sagemaker", - "cloudFormationName": "SageMakerA2IRuntime", - "cloudTrailEventSource": "sagemakera2iruntime.amazonaws.com", - "endpointPrefix": "a2i-runtime.sagemaker" - }, - "aws.auth#sigv4": { - "name": "sagemaker" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning\n application. When an AI application can't evaluate data with a high degree of confidence,\n human reviewers can take over. This human review is called a human review workflow. To create\n and start a human review workflow, you need three resources: a worker task\n template, a flow definition, and a human\n loop.

\n

For information about these resources and prerequisites for using Amazon A2I, see Get Started with\n Amazon Augmented AI in the Amazon SageMaker Developer Guide.

\n

This API reference includes information about API actions and data types that you can use\n to interact with Amazon A2I programmatically. Use this guide to:

\n \n

Amazon A2I integrates APIs from various AWS services to create and start human review\n workflows for those services. To learn how Amazon A2I uses these APIs, see Use APIs in\n Amazon A2I in the Amazon SageMaker Developer Guide.

", - "smithy.api#title": "Amazon Augmented AI Runtime" - } + ] }, "com.amazonaws.sagemakera2iruntime#ConflictException": { "type": "structure", @@ -271,7 +271,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*" + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/" } }, "com.amazonaws.sagemakera2iruntime#HumanLoopArn": { @@ -281,7 +281,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:human-loop/.*" + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:human-loop/" } }, "com.amazonaws.sagemakera2iruntime#HumanLoopDataAttributes": { @@ -464,6 +464,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "HumanLoopSummaries", "pageSize": "MaxResults" } } @@ -736,7 +737,10 @@ } }, "com.amazonaws.sagemakera2iruntime#Timestamp": { - "type": "timestamp" + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } }, "com.amazonaws.sagemakera2iruntime#ValidationException": { "type": "structure", diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index b04e2a4f145..824f47adb10 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -240,7 +240,7 @@ "target": "com.amazonaws.sagemaker#AddTagsOutput" }, "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services\n Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

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

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

\n " } }, "com.amazonaws.sagemaker#AddTagsInput": { @@ -256,7 +256,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

", "smithy.api#required": {} } } @@ -454,13 +454,13 @@ "TrainingImage": { "target": "com.amazonaws.sagemaker#AlgorithmImage", "traits": { - "smithy.api#documentation": "

The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. \n SageMaker supports both registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

\n \n

You must specify either the algorithm name to the AlgorithmName parameter \n or the image URI of the algorithm container \n to the TrainingImage parameter.

\n

For more information, see the note in the AlgorithmName parameter description.

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

The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry\n Paths and Example Code in the Amazon SageMaker developer guide.\n SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information\n about using your custom training container, see Using Your Own Algorithms with\n Amazon SageMaker.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

For more information, see the note in the AlgorithmName parameter\n description.

\n " } }, "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

\n \n

You must specify either the algorithm name to the AlgorithmName parameter \n or the image URI of the algorithm container \n to the TrainingImage parameter.

\n

Note that the AlgorithmName parameter is mutually exclusive \n with the TrainingImage parameter. \n If you specify a value for the AlgorithmName parameter,\n you can't specify a value for TrainingImage, and vice versa.

\n

If you specify values for both parameters, the training job might break; if you don't specify\n any value for both parameters, the training job might raise a null error.

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

The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services\n Marketplace.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

Note that the AlgorithmName parameter is mutually exclusive with the\n TrainingImage parameter. If you specify a value for the\n AlgorithmName parameter, you can't specify a value for\n TrainingImage, and vice versa.

\n

If you specify values for both parameters, the training job might break; if you\n don't specify any value for both parameters, the training job might raise a\n null error.

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

Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" + "smithy.api#documentation": "

Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.

" } }, "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { @@ -1538,12 +1538,12 @@ "MaxConcurrentInvocationsPerInstance": { "target": "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance", "traits": { - "smithy.api#documentation": "

The maximum number of concurrent requests sent by the SageMaker client to the \n model container. If no value is provided, SageMaker chooses an optimal value.

" + "smithy.api#documentation": "

The maximum number of concurrent requests sent by the SageMaker client to the model\n container. If no value is provided, SageMaker chooses an optimal value.

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

Configures the behavior of the client used by SageMaker to interact with the \n model container during asynchronous inference.

" + "smithy.api#documentation": "

Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.

" } }, "com.amazonaws.sagemaker#AsyncInferenceConfig": { @@ -1552,7 +1552,7 @@ "ClientConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceClientConfig", "traits": { - "smithy.api#documentation": "

Configures the behavior of the client used by SageMaker to interact \n with the model container during asynchronous inference.

" + "smithy.api#documentation": "

Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.

" } }, "OutputConfig": { @@ -1573,18 +1573,18 @@ "SuccessTopic": { "target": "com.amazonaws.sagemaker#SnsTopicArn", "traits": { - "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference completes successfully. \n If no topic is provided, no notification is sent on success.

" + "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference completes successfully. If no\n topic is provided, no notification is sent on success.

" } }, "ErrorTopic": { "target": "com.amazonaws.sagemaker#SnsTopicArn", "traits": { - "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference fails. \n If no topic is provided, no notification is sent on failure.

" + "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference fails. If no topic is provided,\n no notification is sent on failure.

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

Specifies the configuration for notifications of inference results for asynchronous inference.

" + "smithy.api#documentation": "

Specifies the configuration for notifications of inference results for asynchronous\n inference.

" } }, "com.amazonaws.sagemaker#AsyncInferenceOutputConfig": { @@ -1593,7 +1593,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that\n SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

\n

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the asynchronous inference output in Amazon S3.

\n

" } }, "S3OutputPath": { @@ -1606,7 +1606,7 @@ "NotificationConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig", "traits": { - "smithy.api#documentation": "

Specifies the configuration for notifications of inference results for asynchronous inference.

" + "smithy.api#documentation": "

Specifies the configuration for notifications of inference results for asynchronous\n inference.

" } } }, @@ -2631,12 +2631,12 @@ "Alarms": { "target": "com.amazonaws.sagemaker#AlarmList", "traits": { - "smithy.api#documentation": "

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint.\n If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

" + "smithy.api#documentation": "

List of CloudWatch alarms in your account that are configured to monitor metrics on an\n endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the\n deployment.

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

Automatic rollback configuration for handling endpoint deployment failures and recovery.

" + "smithy.api#documentation": "

Automatic rollback configuration for handling endpoint deployment failures and\n recovery.

" } }, "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource": { @@ -2851,7 +2851,7 @@ "TrafficRoutingConfiguration": { "target": "com.amazonaws.sagemaker#TrafficRoutingConfig", "traits": { - "smithy.api#documentation": "

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet\n during an endpoint deployment.

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

Defines the traffic routing strategy to shift traffic from the old fleet to the new\n fleet during an endpoint deployment.

", "smithy.api#required": {} } }, @@ -2864,7 +2864,7 @@ "MaximumExecutionTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", "traits": { - "smithy.api#documentation": "

Maximum execution timeout for the deployment. Note that the timeout value should be larger\n than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

" + "smithy.api#documentation": "

Maximum execution timeout for the deployment. Note that the timeout value should be\n larger than the total waiting time specified in TerminationWaitInSeconds\n and WaitIntervalInSeconds.

" } } }, @@ -3114,14 +3114,14 @@ "Type": { "target": "com.amazonaws.sagemaker#CapacitySizeType", "traits": { - "smithy.api#documentation": "

Specifies the endpoint capacity type.

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

Specifies the endpoint capacity type.

\n ", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.sagemaker#CapacitySizeValue", "traits": { - "smithy.api#documentation": "

Defines the capacity size, either as a number of instances or a capacity percentage.

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

Defines the capacity size, either as a number of instances or a capacity\n percentage.

", "smithy.api#required": {} } } @@ -3701,7 +3701,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfig", "traits": { - "smithy.api#documentation": "

Configuration details for the Git repository, including the URL where it is located\n and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to\n access the repository.

" + "smithy.api#documentation": "

Configuration details for the Git repository, including the URL where it is located\n and the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.

" } } }, @@ -4112,7 +4112,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to\n download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your\n IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you\n need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

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

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token\n Service to download model artifacts from the S3 path you provide. Amazon Web Services STS\n is activated in your IAM user account by default. If you previously deactivated\n Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS\n for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

\n " } }, "Environment": { @@ -4512,7 +4512,7 @@ "target": "com.amazonaws.sagemaker#CreateAlgorithmOutput" }, "traits": { - "smithy.api#documentation": "

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services\n Marketplace.

" + "smithy.api#documentation": "

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

" } }, "com.amazonaws.sagemaker#CreateAlgorithmInput": { @@ -4553,13 +4553,13 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

" + "smithy.api#documentation": "

Whether to certify the algorithm so that it can be listed in Amazon Web Services\n Marketplace.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } } } @@ -4632,7 +4632,7 @@ "KernelGatewayImageConfig": { "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", "traits": { - "smithy.api#documentation": "

The KernelGatewayImageConfig.

" + "smithy.api#documentation": "

The KernelGatewayImageConfig. You can only specify one image kernel in the \n\tAppImageConfig API. This kernel will be shown to users before the \n\timage starts. Once the image runs, all kernels are visible in JupyterLab.

" } } } @@ -4882,7 +4882,7 @@ "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" }, "traits": { - "smithy.api#documentation": "

Creates a Git repository as a resource in your SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit or in any\n other Git repository.

" + "smithy.api#documentation": "

Creates a Git repository as a resource in your SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit\n or in any other Git repository.

" } }, "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { @@ -4905,7 +4905,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } } } @@ -5332,7 +5332,7 @@ "AppSecurityGroupManagement": { "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", "traits": { - "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.

" + "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.

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

Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using SageMaker hosting services.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

\n

When it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you\n provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For\n more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

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

Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using SageMaker hosting services.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.

\n

When it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your IAM user account by\n default. If you previously deactivated Amazon Web Services STS for a region, you need to\n reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

\n \n\n " } }, "com.amazonaws.sagemaker#CreateEndpointConfig": { @@ -5596,19 +5596,19 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n \n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

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

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that\n hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n \n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " } }, "AsyncInferenceConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", "traits": { - "smithy.api#documentation": "

Specifies configuration for how an endpoint performs asynchronous inference. \n This is a required field in order for your Endpoint to be invoked using\n InvokeEndpointAsync.

" + "smithy.api#documentation": "

Specifies configuration for how an endpoint performs asynchronous inference. This is a\n required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

" } } } @@ -5631,7 +5631,7 @@ "EndpointName": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services\n account. The name is case-insensitive in CreateEndpoint, but the case is\n preserved and must be matched in .

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

The name of the endpoint.The name must be unique within an Amazon Web Services\n Region in your Amazon Web Services account. The name is case-insensitive in\n CreateEndpoint, but the case is preserved and must be matched in .

", "smithy.api#required": {} } }, @@ -5648,7 +5648,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } } } @@ -5983,7 +5983,7 @@ "HyperParameterTuningJobName": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", "traits": { - "smithy.api#documentation": "

The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same Amazon Web Services account and\n Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9,\n and : + = @ _ % - (hyphen). The name is not case sensitive.

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

The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid\n characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case\n sensitive.

", "smithy.api#required": {} } }, @@ -6015,7 +6015,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

\n

Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

\n

Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

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

Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see Create a Model (Amazon Web Services SDK for Python (Boto\n 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources,\n you grant necessary permissions via this role.

" + "smithy.api#documentation": "

Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see Create a Model (Amazon Web Services SDK for Python (Boto 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

" } }, "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { @@ -6604,7 +6604,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } }, "VpcConfig": { @@ -7033,20 +7033,20 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker\n assumes this role to perform tasks on your behalf. You must grant this role necessary\n permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service\n principal (sagemaker.amazonaws.com) permissions to assume this role. For more\n information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

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

When you send any requests to Amazon Web Services resources from the notebook\n instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this\n role necessary permissions so SageMaker can perform these tasks. The policy must allow the\n SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For\n more information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to your notebook instance. The KMS key you provide must be\n enabled. For information, see Enabling and Disabling\n Keys in the Amazon Web Services Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The\n KMS key you provide must be enabled. For information, see Enabling and Disabling\n Keys in the Amazon Web Services Key Management Service Developer\n Guide.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } }, "LifecycleConfigName": { @@ -7076,13 +7076,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "RootAccess": { @@ -7330,7 +7330,7 @@ "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" }, "traits": { - "smithy.api#documentation": "

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker console, when you choose Open next to a notebook\n instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.

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

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker console, when you choose Open next to a notebook\n instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.

\n " } }, "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput": { @@ -7625,7 +7625,7 @@ "TrainingJobName": { "target": "com.amazonaws.sagemaker#TrainingJobName", "traits": { - "smithy.api#documentation": "

The name of the training job. The name must be unique within an Amazon Web Services Region in an\n Amazon Web Services account.

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

The name of the training job. The name must be unique within an Amazon Web Services\n Region in an Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -7652,7 +7652,7 @@ "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be\n downloaded.

" + "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.

" } }, "OutputDataConfig": { @@ -7685,7 +7685,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } }, "EnableNetworkIsolation": { @@ -9319,7 +9319,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.

\n

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.

\n

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants.\n You might still see these resources in your account for a few minutes after deleting your endpoint.\n Do not delete or revoke the permissions for your\n \n ExecutionRoleArn\n ,\n otherwise SageMaker cannot delete these resources.

" + "smithy.api#documentation": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.

\n

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.

\n

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint\n resources such as KMS key grants. You might still see these resources in your account\n for a few minutes after deleting your endpoint. Do not delete or revoke the permissions\n for your \n ExecutionRoleArn\n , otherwise SageMaker cannot delete these\n resources.

" } }, "com.amazonaws.sagemaker#DeleteEndpointConfig": { @@ -9584,7 +9584,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes a model. The DeleteModel API deletes only the model entry that\n was created in SageMaker when you called the CreateModel API. It does not\n delete model artifacts, inference code, or the IAM role that you specified when\n creating the model.

" + "smithy.api#documentation": "

Deletes a model. The DeleteModel API deletes only the model entry that\n was created in SageMaker when you called the CreateModel API. It does not delete\n model artifacts, inference code, or the IAM role that you specified when creating the\n model.

" } }, "com.amazonaws.sagemaker#DeleteModelBiasJobDefinition": { @@ -10222,7 +10222,7 @@ "AutoRollbackConfiguration": { "target": "com.amazonaws.sagemaker#AutoRollbackConfig", "traits": { - "smithy.api#documentation": "

Automatic rollback configuration for handling endpoint deployment failures and recovery.

" + "smithy.api#documentation": "

Automatic rollback configuration for handling endpoint deployment failures and\n recovery.

" } } }, @@ -10544,7 +10544,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

" + "smithy.api#documentation": "

Whether the algorithm is certified to be listed in Amazon Web Services\n Marketplace.

" } } } @@ -11052,7 +11052,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfig", "traits": { - "smithy.api#documentation": "

Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets\n Manager secret that contains the credentials used to access the repository.

" + "smithy.api#documentation": "

Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the\n repository.

" } } } @@ -11750,13 +11750,13 @@ "AppSecurityGroupManagement": { "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", "traits": { - "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. \n Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

" + "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.

" } }, "SecurityGroupIdForDomainBoundary": { "target": "com.amazonaws.sagemaker#SecurityGroupId", "traits": { - "smithy.api#documentation": "

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

" + "smithy.api#documentation": "

The ID of the security group that authorizes traffic between the\n RSessionGateway apps and the RStudioServerPro app.

" } } } @@ -12128,7 +12128,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" + "smithy.api#documentation": "

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on\n the ML storage volume attached to the instance.

" } }, "CreationTime": { @@ -12141,7 +12141,7 @@ "AsyncInferenceConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", "traits": { - "smithy.api#documentation": "

Returns the description of an endpoint configuration created using the \n \n CreateEndpointConfig\n API.

" + "smithy.api#documentation": "

Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.

" } } } @@ -12227,7 +12227,7 @@ "AsyncInferenceConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", "traits": { - "smithy.api#documentation": "

Returns the description of an endpoint configuration created \n using the \n CreateEndpointConfig\n API.

" + "smithy.api#documentation": "

Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.

" } }, "PendingDeploymentSummary": { @@ -13431,7 +13431,7 @@ "OutputConfig": { "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", "traits": { - "smithy.api#documentation": "

The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to\n encrypt the output data, if any.

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

The location of the job's output data and the Amazon Web Services Key Management\n Service key ID for the key used to encrypt the output data, if any.

", "smithy.api#required": {} } }, @@ -13470,7 +13470,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } }, "LabelingJobOutput": { @@ -14522,7 +14522,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the\n ML storage volume attached to the instance.

" } }, "NetworkInterfaceId": { @@ -14570,13 +14570,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "RootAccess": { @@ -15414,7 +15414,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

" + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for\n the training job.

" } }, "InputDataConfig": { @@ -16911,18 +16911,18 @@ "SecurityGroupIds": { "target": "com.amazonaws.sagemaker#DomainSecurityGroupIds", "traits": { - "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

" + "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.

" } }, "RStudioServerProDomainSettings": { "target": "com.amazonaws.sagemaker#RStudioServerProDomainSettings", "traits": { - "smithy.api#documentation": "

A collection of settings that configure the RStudioServerPro Domain-level app.

" + "smithy.api#documentation": "

A collection of settings that configure the RStudioServerPro Domain-level\n app.

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

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

" + "smithy.api#documentation": "

A collection of settings that apply to the SageMaker Domain. These\n settings are specified through the CreateDomain API call.

" } }, "com.amazonaws.sagemaker#DomainSettingsForUpdate": { @@ -16931,7 +16931,7 @@ "RStudioServerProDomainSettingsForUpdate": { "target": "com.amazonaws.sagemaker#RStudioServerProDomainSettingsForUpdate", "traits": { - "smithy.api#documentation": "

A collection of RStudioServerPro Domain-level app settings to update.

" + "smithy.api#documentation": "

A collection of RStudioServerPro Domain-level app settings to\n update.

" } } }, @@ -17780,7 +17780,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" + "smithy.api#documentation": "

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.

" } } }, @@ -19780,12 +19780,12 @@ "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the git repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

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

Specifies configuration details for a Git repository in your Amazon Web Services account.

" + "smithy.api#documentation": "

Specifies configuration details for a Git repository in your Amazon Web Services\n account.

" } }, "com.amazonaws.sagemaker#GitConfigForUpdate": { @@ -19794,7 +19794,7 @@ "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the git repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } }, @@ -20298,8 +20298,7 @@ "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.

\n

Storage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.

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

The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.

\n

Storage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.

\n \n

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

\n " } }, "StoppingCondition": { @@ -20335,6 +20334,12 @@ "traits": { "smithy.api#documentation": "

The number of times to retry the job when the job fails due to an\n InternalServerError.

" } + }, + "HyperParameterTuningResourceConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningResourceConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the hyperparameter tuning resources, including the compute\n instances and storage volumes, used for training jobs launched by the tuning job. By\n default, storage volumes hold model artifacts and incremental states. Choose\n File for TrainingInputMode in the\n AlgorithmSpecificationparameter to additionally store training data in\n the storage volume (optional).

" + } } }, "traits": { @@ -20454,6 +20459,58 @@ "smithy.api#documentation": "

The container for the summary information about a training job.

" } }, + "com.amazonaws.sagemaker#HyperParameterTuningAllocationStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Prioritized", + "name": "PRIORITIZED" + } + ] + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type used for processing of hyperparameter optimization jobs. Choose from\n general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge\n or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more\n information about instance types, see instance type\n descriptions.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See SageMaker distributed training\n jobs for more information.

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

The volume size in GB of the data to be processed for hyperparameter optimization\n (optional).

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

The configuration for hyperparameter tuning resources for use in training jobs\n launched by the tuning job. These resources include compute instances and storage\n volumes. Specify one or more compute instance configurations and allocation strategies\n to select resources (optional).

" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, "com.amazonaws.sagemaker#HyperParameterTuningJobArn": { "type": "string", "traits": { @@ -20743,6 +20800,50 @@ ] } }, + "com.amazonaws.sagemaker#HyperParameterTuningResourceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of\n instance types for more information.

" + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "

The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.

\n

Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.

\n \n

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

\n " + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

A key used by AWS Key Management Service to encrypt data on the storage volume attached to the compute\n instances used to run the training job. You can use either of the following formats to\n specify a key.

\n

KMS Key ID:

\n

\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Amazon Resource Name (ARN) of a AWS KMS key:

\n

\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these\n instance types, you cannot request a VolumeKmsKeyId. For a list of instance\n types that use local storage, see instance store volumes. For more information about AWS Key Management Service, see AWS KMS encryption for more information.

" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The strategy that determines the order of preference for resources specified in\n InstanceConfigs used in hyperparameter optimization.

" + } + }, + "InstanceConfigs": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs", + "traits": { + "smithy.api#documentation": "

A list containing the configuration(s) for one or more resources for processing\n hyperparameter jobs. These resources include compute instances and storage volumes to\n use in model training jobs launched by hyperparameter tuning jobs. The\n AllocationStrategy controls the order in which multiple configurations\n provided in InstanceConfigs are used.

\n \n

If you only want to use a single InstanceConfig inside the\n HyperParameterTuningResourceConfig API, do not provide a value for\n InstanceConfigs. Instead, use InstanceType,\n VolumeSizeInGB and InstanceCount. If you use\n InstanceConfigs, do not provide values for\n InstanceType, VolumeSizeInGB or\n InstanceCount.

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

The configuration of resources, including compute instances and storage volumes for\n use in training jobs launched by hyperparameter tuning jobs. Specify one or more\n instance type and count and the allocation strategy for instance selection.

\n \n

HyperParameterTuningResourceConfig supports all of the capabilities of\n ResourceConfig with added functionality for flexible instance management.

\n " + } + }, "com.amazonaws.sagemaker#HyperParameterValue": { "type": "string", "traits": { @@ -21517,7 +21618,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines an instance group for heterogeneous cluster training. \n When requesting a training job using the CreateTrainingJob API, \n you can configure multiple instance groups .

" + "smithy.api#documentation": "

Defines an instance group for heterogeneous cluster training. When requesting a\n training job using the CreateTrainingJob API, you can configure multiple instance groups .

" } }, "com.amazonaws.sagemaker#InstanceGroupName": { @@ -22347,7 +22448,7 @@ "WorkRequesterAccountId": { "target": "com.amazonaws.sagemaker#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account used to start the labeling job.

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

The Amazon Web Services account ID of the account used to start the labeling\n job.

", "smithy.api#required": {} } }, @@ -23658,7 +23759,7 @@ "CodeRepositorySummaryList": { "target": "com.amazonaws.sagemaker#CodeRepositorySummaryList", "traits": { - "smithy.api#documentation": "

Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:

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

Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:

\n ", "smithy.api#required": {} } }, @@ -26236,7 +26337,7 @@ "NameContains": { "target": "com.amazonaws.sagemaker#ModelNameContains", "traits": { - "smithy.api#documentation": "

A string in the model name. This filter returns only models whose \n name contains the specified string.

" + "smithy.api#documentation": "

A string in the model name. This filter returns only models whose name contains the\n specified string.

" } }, "CreationTimeBefore": { @@ -26624,7 +26725,7 @@ "target": "com.amazonaws.sagemaker#ListNotebookInstancesOutput" }, "traits": { - "smithy.api#documentation": "

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services\n Region.

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

Returns a list of the SageMaker notebook instances in the requester's account in an\n Amazon Web Services Region.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -27536,7 +27637,7 @@ "target": "com.amazonaws.sagemaker#ListTrainingJobsResponse" }, "traits": { - "smithy.api#documentation": "

Lists training jobs.

\n \n

When StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.

\n

For example, if ListTrainingJobs is invoked with the following\n parameters:

\n

\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n

\n

First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.

\n

You can quickly test the API using the following Amazon Web Services CLI code.

\n

\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n

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

Lists training jobs.

\n \n

When StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.

\n

For example, if ListTrainingJobs is invoked with the following\n parameters:

\n

\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n

\n

First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.

\n

You can quickly test the API using the following Amazon Web Services CLI\n code.

\n

\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28836,13 +28937,13 @@ "InvocationsTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds", "traits": { - "smithy.api#documentation": "

The timeout value in seconds for an invocation request. The default value is 600.

" + "smithy.api#documentation": "

The timeout value in seconds for an invocation request. The default value is\n 600.

" } }, "InvocationsMaxRetries": { "target": "com.amazonaws.sagemaker#InvocationsMaxRetries", "traits": { - "smithy.api#documentation": "

The maximum number of retries when invocation requests are failing. The default value is 3.

" + "smithy.api#documentation": "

The maximum number of retries when invocation requests are failing. The default value\n is 3.

" } } }, @@ -31421,13 +31522,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } } }, @@ -31925,7 +32026,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.

" } }, "S3OutputPath": { @@ -32102,7 +32203,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.

\n \n

The maximum number of items specified for Array Members refers to\n the maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.

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

Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.

\n \n

The maximum number of items specified for Array Members refers to the\n maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.

\n " } }, "com.amazonaws.sagemaker#ParameterType": { @@ -32226,7 +32327,7 @@ } }, "traits": { - "smithy.api#documentation": "

The summary of an in-progress deployment when an endpoint is creating or\n updating with a new endpoint configuration.

" + "smithy.api#documentation": "

The summary of an in-progress deployment when an endpoint is creating or updating with\n a new endpoint configuration.

" } }, "com.amazonaws.sagemaker#PendingProductionVariantSummary": { @@ -32242,7 +32343,7 @@ "DeployedImages": { "target": "com.amazonaws.sagemaker#DeployedImages", "traits": { - "smithy.api#documentation": "

An array of DeployedImage objects that specify the Amazon EC2\n Container Registry paths of the inference images deployed on instances of this\n ProductionVariant.

" + "smithy.api#documentation": "

An array of DeployedImage objects that specify the Amazon EC2 Container\n Registry paths of the inference images deployed on instances of this\n ProductionVariant.

" } }, "CurrentWeight": { @@ -32254,7 +32355,7 @@ "DesiredWeight": { "target": "com.amazonaws.sagemaker#VariantWeight", "traits": { - "smithy.api#documentation": "

The requested weight for the variant in this deployment, as specified in the endpoint configuration\n for the endpoint. The value is taken from the request to the \n CreateEndpointConfig\n operation.

" + "smithy.api#documentation": "

The requested weight for the variant in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the \n CreateEndpointConfig\n operation.

" } }, "CurrentInstanceCount": { @@ -32266,7 +32367,7 @@ "DesiredInstanceCount": { "target": "com.amazonaws.sagemaker#TaskCount", "traits": { - "smithy.api#documentation": "

The number of instances requested in this deployment, as specified in the endpoint configuration\n for the endpoint. The value is taken from the request to the \n CreateEndpointConfig\n operation.

" + "smithy.api#documentation": "

The number of instances requested in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the \n CreateEndpointConfig\n operation.

" } }, "InstanceType": { @@ -32278,13 +32379,13 @@ "AcceleratorType": { "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", "traits": { - "smithy.api#documentation": "

The size of the Elastic Inference (EI) instance to use for the production variant. EI\n instances provide on-demand GPU computing for inference. For more information, see\n Using Elastic\n Inference in Amazon SageMaker.

" + "smithy.api#documentation": "

The size of the Elastic Inference (EI) instance to use for the production variant. EI\n instances provide on-demand GPU computing for inference. For more information, see\n Using Elastic\n Inference in Amazon SageMaker.

" } }, "VariantStatus": { "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", "traits": { - "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or operational status.

" + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or\n operational status.

" } }, "CurrentServerlessConfig": { @@ -32301,7 +32402,7 @@ } }, "traits": { - "smithy.api#documentation": "

The production variant summary for a deployment when an endpoint is\n creating or updating with the \n CreateEndpoint\n \n or \n UpdateEndpoint\n operations.\n Describes the VariantStatus , weight and capacity for a production\n variant associated with an endpoint.\n

" + "smithy.api#documentation": "

The production variant summary for a deployment when an endpoint is creating or\n updating with the \n CreateEndpoint\n or \n UpdateEndpoint\n operations. Describes the VariantStatus\n , weight and capacity for a production variant associated with an endpoint.\n

" } }, "com.amazonaws.sagemaker#PendingProductionVariantSummaryList": { @@ -33996,7 +34097,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services\n KMS in the Amazon Web Services Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management\n Service Developer Guide.

" } } }, @@ -34387,7 +34488,7 @@ "Status": { "target": "com.amazonaws.sagemaker#VariantStatus", "traits": { - "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or operational status.

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

The endpoint variant status which describes the current deployment stage status or\n operational status.

\n ", "smithy.api#required": {} } }, @@ -34463,7 +34564,7 @@ "VariantStatus": { "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", "traits": { - "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or operational status.

" + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or\n operational status.

" } }, "CurrentServerlessConfig": { @@ -34757,7 +34858,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } }, "LastModifiedTime": { @@ -35407,18 +35508,18 @@ "AccessStatus": { "target": "com.amazonaws.sagemaker#RStudioServerProAccessStatus", "traits": { - "smithy.api#documentation": "

Indicates whether the current user has access to the RStudioServerPro app.

" + "smithy.api#documentation": "

Indicates whether the current user has access to the RStudioServerPro\n app.

" } }, "UserGroup": { "target": "com.amazonaws.sagemaker#RStudioServerProUserGroup", "traits": { - "smithy.api#documentation": "

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

" + "smithy.api#documentation": "

The level of permissions that the user has within the RStudioServerPro\n app. This value defaults to `User`. The `Admin` value allows the user access to the\n RStudio Administrative Dashboard.

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

A collection of settings that configure user interaction with the RStudioServerPro app. RStudioServerProAppSettings cannot be updated. The RStudioServerPro app must be deleted and a new one created to make any changes.

" + "smithy.api#documentation": "

A collection of settings that configure user interaction with the\n RStudioServerPro app. RStudioServerProAppSettings cannot\n be updated. The RStudioServerPro app must be deleted and a new one created\n to make any changes.

" } }, "com.amazonaws.sagemaker#RStudioServerProDomainSettings": { @@ -35427,7 +35528,7 @@ "DomainExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the execution role for the RStudioServerPro Domain-level app.

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

The ARN of the execution role for the RStudioServerPro Domain-level\n app.

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

A collection of settings that configure the RStudioServerPro Domain-level app.

" + "smithy.api#documentation": "

A collection of settings that configure the RStudioServerPro Domain-level\n app.

" } }, "com.amazonaws.sagemaker#RStudioServerProDomainSettingsForUpdate": { @@ -35466,7 +35567,7 @@ } }, "traits": { - "smithy.api#documentation": "

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

" + "smithy.api#documentation": "

A collection of settings that update the current configuration for the\n RStudioServerPro Domain-level app.

" } }, "com.amazonaws.sagemaker#RStudioServerProUserGroup": { @@ -36071,13 +36172,13 @@ "RepositoryCredentialsProviderArn": { "target": "com.amazonaws.sagemaker#RepositoryCredentialsProviderArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to\n authenticate to the private Docker registry where your model image is hosted. For\n information about how to create an Amazon Web Services Lambda function, see Create a Lambda function\n with the console in the Amazon Web Services Lambda Developer\n Guide.

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

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides\n credentials to authenticate to the private Docker registry where your model image is\n hosted. For information about how to create an Amazon Web Services Lambda function, see\n Create a Lambda function\n with the console in the Amazon Web Services Lambda Developer\n Guide.

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

Specifies an authentication configuration for the private docker registry where your\n model image is hosted. Specify a value for this property only if you specified\n Vpc as the value for the RepositoryAccessMode field of the\n ImageConfig object that you passed to a call to CreateModel\n and the private Docker registry where the model image is\n hosted requires authentication.

" + "smithy.api#documentation": "

Specifies an authentication configuration for the private docker registry where your\n model image is hosted. Specify a value for this property only if you specified\n Vpc as the value for the RepositoryAccessMode field of the\n ImageConfig object that you passed to a call to\n CreateModel and the private Docker registry where the model image is\n hosted requires authentication.

" } }, "com.amazonaws.sagemaker#RepositoryCredentialsProviderArn": { @@ -36145,7 +36246,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

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

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

\n " } }, "InstanceGroups": { @@ -36581,7 +36682,7 @@ "InstanceGroupNames": { "target": "com.amazonaws.sagemaker#InstanceGroupNames", "traits": { - "smithy.api#documentation": "

A list of names of instance groups that get data \n from the S3 data source.

" + "smithy.api#documentation": "

A list of names of instance groups that get data from the S3 data source.

" } } }, @@ -38367,13 +38468,13 @@ "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

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

The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

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

Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

" + "smithy.api#documentation": "

Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

" } }, "com.amazonaws.sagemaker#SourceAlgorithmList": { @@ -39140,7 +39241,7 @@ "MaxRuntimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxRuntimeInSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can run.

\n

For compilation jobs, if the job does not complete during this time, a TimeOut error\n is generated. We recommend starting with 900 seconds and increasing as \n necessary based on your model.

\n

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When \n RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

" + "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can\n run.

\n

For compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.

\n

For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.

" } }, "MaxWaitTimeInSeconds": { @@ -39151,7 +39252,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job or model compilation job \n can run. It also specifies how long a managed spot training\n job has to complete. When the job reaches the time limit, SageMaker ends the training or\n compilation job. Use this API to cap model training costs.

\n

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

\n

The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.

\n \n

The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.

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

Specifies a limit to how long a model training job or model compilation job can run.\n It also specifies how long a managed spot training job has to complete. When the job\n reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap\n model training costs.

\n

To stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.

\n

The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.

\n \n

The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.

\n " } }, "com.amazonaws.sagemaker#String": { @@ -39480,7 +39581,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.

\n

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.

\n

For more information on adding metadata to your Amazon Web Services resources with tagging, see\n Tagging Amazon Web Services\n resources. For advice on best practices for managing Amazon Web Services resources with\n tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

" + "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.

\n

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.

\n

For more information on adding metadata to your Amazon Web Services resources with\n tagging, see Tagging Amazon Web Services resources. For advice on best practices for\n managing Amazon Web Services resources with tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging\n Strategy.

" } }, "com.amazonaws.sagemaker#TagKey": { @@ -40074,7 +40175,7 @@ "com.amazonaws.sagemaker#TrainingInputMode": { "type": "string", "traits": { - "smithy.api#documentation": "

The training input mode that the algorithm supports. For more information about input modes, see\n Algorithms.

\n\n

\n Pipe mode\n

\n

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly\n from Amazon S3 to the container.

\n\n

\n File mode\n

\n

If an algorithm supports File mode, SageMaker\n downloads the training data from S3 to the provisioned ML storage volume, and mounts the\n directory to the Docker volume for the training container.

\n

You must provision the ML storage volume with sufficient capacity\n to accommodate the data downloaded from S3. In addition to the training data, the ML\n storage volume also stores the output model. The algorithm container uses the ML storage\n volume to also store intermediate information, if any.

\n

For distributed algorithms, training data is distributed uniformly.\n Your training duration is predictable if the input data objects sizes are\n approximately the same. SageMaker does not split the files any further for model training.\n If the object sizes are skewed, training won't be optimal as the data distribution is also\n skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in\n training.

\n\n

\n FastFile mode\n

\n

If an algorithm supports FastFile mode, SageMaker streams data directly\n from S3 to the container with no code changes, and provides file system access to\n the data. Users can author their training script to interact with these files as if\n they were stored on disk.

\n

\n FastFile mode works best when the data is read sequentially.\n Augmented manifest files aren't supported.\n The startup time is lower when there are fewer files in the S3 bucket provided.

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

The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.

\n\n

\n Pipe mode\n

\n

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.

\n\n

\n File mode\n

\n

If an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.

\n

You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.

\n

For distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.

\n\n

\n FastFile mode\n

\n

If an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.

\n

\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.

", "smithy.api#enum": [ { "value": "Pipe", @@ -40372,7 +40473,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

" + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the\n training job.

" } }, "InputDataConfig": { @@ -40510,7 +40611,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" } } }, @@ -42445,7 +42546,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfigForUpdate", "traits": { - "smithy.api#documentation": "

The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to\n access the repository. The secret must have a staging label of AWSCURRENT\n and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } } @@ -42715,7 +42816,7 @@ "DeploymentConfig": { "target": "com.amazonaws.sagemaker#DeploymentConfig", "traits": { - "smithy.api#documentation": "

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

" + "smithy.api#documentation": "

The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.

" } }, "RetainDeploymentConfig": { @@ -42871,7 +42972,7 @@ "FeatureAdditions": { "target": "com.amazonaws.sagemaker#FeatureAdditions", "traits": { - "smithy.api#documentation": "

A list of the features that you're adding to the feature group.

" + "smithy.api#documentation": "

Updates the feature group. Updating a feature group is an asynchronous operation. When\n you get an HTTP 200 response, you've made a valid request. It takes some time after you've\n made a valid request for Feature Store to update the feature group.

" } } } @@ -43186,13 +43287,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "AcceleratorTypes": { @@ -43453,7 +43554,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your \n Amazon Web Services resources in different ways, for example, by purpose, owner, or \n environment. For more information, see Tagging Amazon Web Services Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your \n Amazon Web Services resources in different ways, for example, by purpose, owner, or \n environment. For more information, see Tagging Amazon Web Services Resources.\n In addition, the project must have tag update constraints set in order to include this \n parameter in the request. For more information, see Amazon Web Services Service \n Catalog Tag Update Constraints.

" } } } @@ -44044,7 +44145,7 @@ "RStudioServerProAppSettings": { "target": "com.amazonaws.sagemaker#RStudioServerProAppSettings", "traits": { - "smithy.api#documentation": "

A collection of settings that configure user interaction with the RStudioServerPro app.

" + "smithy.api#documentation": "

A collection of settings that configure user interaction with the\n RStudioServerPro app.

" } }, "RSessionAppSettings": { diff --git a/codegen/sdk/aws-models/secrets-manager.json b/codegen/sdk/aws-models/secrets-manager.json index 92219ac7dd2..8d607c80fae 100644 --- a/codegen/sdk/aws-models/secrets-manager.json +++ b/codegen/sdk/aws-models/secrets-manager.json @@ -192,7 +192,7 @@ "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to\n encrypt the secret value in the secret.

\n

To use a KMS key in a different account, use the key ARN or the alias ARN.

\n

If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. \n If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it \n encrypts the secret value.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.

" + "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to\n encrypt the secret value in the secret. An alias is always prefixed by alias/, \n for example alias/aws/secretsmanager. For more information, see About aliases.

\n

To use a KMS key in a different account, use the key ARN or the alias ARN.

\n

If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. \n If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it \n encrypts the secret value.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.

" } }, "SecretBinary": { @@ -466,7 +466,7 @@ "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with \n the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

" + "smithy.api#documentation": "

The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. \n If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, \n this field is omitted. Secrets created using the console use an KMS key ID.

" } }, "RotationEnabled": { @@ -503,7 +503,7 @@ "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { - "smithy.api#documentation": "

The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.

" + "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

" } }, "DeletedDate": { @@ -527,7 +527,7 @@ "OwningService": { "target": "com.amazonaws.secretsmanager#OwningServiceType", "traits": { - "smithy.api#documentation": "

The name of the service that created this secret.

" + "smithy.api#documentation": "

The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.

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

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.

\n \n

\n Required permissions: \n secretsmanager:GetSecretValue. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.

\n

To retrieve the previous version of a secret, use VersionStage and specify \n AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.

\n \n

\n Required permissions: \n secretsmanager:GetSecretValue. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#GetSecretValueRequest": { @@ -992,7 +992,7 @@ } }, "traits": { - "smithy.api#documentation": "

A parameter value is not valid for the current state of the\n resource.

\n

Possible causes:

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

A parameter value is not valid for the current state of the\n resource.

\n

Possible causes:

\n ", "smithy.api#error": "client" } }, @@ -1688,7 +1688,7 @@ "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { - "smithy.api#documentation": "

The date that you last accessed the secret in the Region.

" + "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

" } } }, @@ -2003,7 +2003,7 @@ "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { - "smithy.api#documentation": "

The last date that this secret was accessed. This value is truncated to midnight of the\n date and therefore shows only the date, not the time.

" + "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

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

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

\n

If you call this operation with a ClientRequestToken that matches an existing version's \n VersionId, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key.

\n

\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" + "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

\n

If you call this operation with a ClientRequestToken that matches an existing version's \n VersionId, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.

\n

\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" } }, "com.amazonaws.secretsmanager#UpdateSecretRequest": { @@ -2460,7 +2460,7 @@ "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager \n uses to encrypt new secret versions as well as any existing versions the staging labels \n AWSCURRENT, AWSPENDING, or AWSPREVIOUS. \n For more information about versions and staging labels, see Concepts: Version.

\n \n

You can only use the Amazon Web Services managed key aws/secretsmanager if you call this\n operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in\n a different account, then you must use a customer managed key and provide the ARN of that KMS key in\n this field. The user making the call must have permissions to both the secret and the KMS key in\n their respective accounts.

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

The ARN, key ID, or alias of the KMS key that Secrets Manager \n uses to encrypt new secret versions as well as any existing versions with the staging labels \n AWSCURRENT, AWSPENDING, or AWSPREVIOUS. \n For more information about versions and staging labels, see Concepts: Version.

\n

A key alias is always prefixed by alias/, for example alias/aws/secretsmanager.\n For more information, see About aliases.

\n

If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.

\n \n

You can only use the Amazon Web Services managed key aws/secretsmanager if you call this\n operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in\n a different account, then you must use a customer managed key and provide the ARN of that KMS key in\n this field. The user making the call must have permissions to both the secret and the KMS key in\n their respective accounts.

\n " } }, "SecretBinary": { diff --git a/codegen/sdk/aws-models/service-catalog.json b/codegen/sdk/aws-models/service-catalog.json index 5eb2424df33..ee2189d7503 100644 --- a/codegen/sdk/aws-models/service-catalog.json +++ b/codegen/sdk/aws-models/service-catalog.json @@ -43,7 +43,7 @@ "name": "servicecatalog" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Service Catalog\n

\n AWS Service Catalog enables\n organizations to create and manage catalogs of IT services that are approved for AWS. To\n get the most out of this documentation, you should be familiar with the terminology\n discussed in AWS Service Catalog\n Concepts.

", + "smithy.api#documentation": "AWS Service Catalog\n

\n Service Catalog enables\n organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To\n get the most out of this documentation, you should be familiar with the terminology\n discussed in Service Catalog\n Concepts.

", "smithy.api#title": "AWS Service Catalog" }, "version": "2015-12-10", @@ -1048,7 +1048,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies the specified source product to the specified target product or a new product.

\n

You can copy a product to the same account or another account.\n You can copy a product to the same region or another region.

\n

This operation is performed asynchronously. To track the progress of the\n operation, use DescribeCopyProductStatus.

" + "smithy.api#documentation": "

Copies the specified source product to the specified target product or a new\n product.

\n

You can copy a product to the same account or another account. You can copy a product\n to the same Region or another Region. If you copy a product to another account, you must\n first share the product in a portfolio using CreatePortfolioShare.

\n

This operation is performed asynchronously. To track the progress of the\n operation, use DescribeCopyProductStatus.

" } }, "com.amazonaws.servicecatalog#CopyProductInput": { @@ -1183,7 +1183,7 @@ "Parameters": { "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { - "smithy.api#documentation": "

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

\n
\n
LAUNCH
\n
\n

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

\n

Specify the RoleArn property as follows:

\n

\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

\n

Specify the LocalRoleName property as follows:

\n

\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

\n

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

\n \n

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

\n \n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one LAUNCH constraint on a product and portfolio.

\n
\n
NOTIFICATION
\n
\n

Specify the NotificationArns property as follows:

\n

\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

\n
\n
RESOURCE_UPDATE
\n
\n

Specify the TagUpdatesOnProvisionedProduct property as follows:

\n

\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

\n

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

\n
\n
STACKSET
\n
\n

Specify the Parameters property as follows:

\n

\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

\n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one STACKSET constraint on a product and portfolio.

\n

Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

\n
\n
TEMPLATE
\n
\n

Specify the Rules property. For more information, see\n Template Constraint Rules.

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

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

\n
\n
LAUNCH
\n
\n

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

\n

Specify the RoleArn property as follows:

\n

\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

\n

Specify the LocalRoleName property as follows:

\n

\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

\n

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

\n \n

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

\n \n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one LAUNCH constraint on a product and portfolio.

\n
\n
NOTIFICATION
\n
\n

Specify the NotificationArns property as follows:

\n

\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

\n
\n
RESOURCE_UPDATE
\n
\n

Specify the TagUpdatesOnProvisionedProduct property as follows:

\n

\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

\n

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

\n
\n
STACKSET
\n
\n

Specify the Parameters property as follows:

\n

\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

\n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one STACKSET constraint on a product and portfolio.

\n

Products with a STACKSET constraint will launch an CloudFormation stack set.

\n
\n
TEMPLATE
\n
\n

Specify the Rules property. For more information, see\n Template Constraint Rules.

\n
\n
", "smithy.api#required": {} } }, @@ -1366,13 +1366,13 @@ "AccountId": { "target": "com.amazonaws.servicecatalog#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID. For example, 123456789012.

" + "smithy.api#documentation": "

The Amazon Web Services account ID. For example, 123456789012.

" } }, "OrganizationNode": { "target": "com.amazonaws.servicecatalog#OrganizationNode", "traits": { - "smithy.api#documentation": "

The organization node to whom you are going to share. If OrganizationNode\n is passed in, PortfolioShare will be created for the node an\n ListOrganizationPortfolioAccessd its children (when applies), and a\n PortfolioShareToken will be returned in the output in order for the\n administrator to monitor the status of the PortfolioShare creation\n process.

" + "smithy.api#documentation": "

The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. \n The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

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

Creates a plan. A plan includes the list of resources to be \n created (when provisioning a new product) or modified (when updating a provisioned product)\n when the plan is executed.

\n

You can create one plan per provisioned product. To create a plan for an existing \n provisioned product, the product status must be AVAILBLE or TAINTED.

\n

To view the resource changes in the change set, use DescribeProvisionedProductPlan.\n To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

" + "smithy.api#documentation": "

Creates a plan.

\n

A plan includes the list of resources to be \n created (when provisioning a new product) or modified (when updating a provisioned product)\n when the plan is executed.

\n

You can create one plan for each provisioned product. To create a plan for an existing \n provisioned product, the product status must be AVAILABLE or TAINTED.

\n

To view the resource changes in the change set, use DescribeProvisionedProductPlan.\n To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

" } }, "com.amazonaws.servicecatalog#CreateProvisionedProductPlanInput": { @@ -1591,7 +1591,7 @@ "ProvisionedProductName": { "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.

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

A user-friendly name for the provisioned product. This value must be\n unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

", "smithy.api#required": {} } }, @@ -1727,7 +1727,7 @@ "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

Specify the template source with one of the following options, but not both. Keys\n accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

\n

The URL of the CloudFormation template in Amazon S3, in JSON format.

\n

\n LoadTemplateFromURL\n

\n

Use the URL of the CloudFormation template in Amazon S3 in JSON format.

\n

\n ImportFromPhysicalId\n

\n

Use the physical id of the resource that contains the template; currently supports\n CloudFormation stack ARN.

" + "smithy.api#documentation": "

Specify the template source with one of the following options, but not both. Keys\n accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

\n

The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.

\n

\n LoadTemplateFromURL\n

\n

Use the URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.

\n

\n ImportFromPhysicalId\n

\n

Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.

" } }, "Status": { @@ -1778,7 +1778,7 @@ "Definition": { "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionMap", "traits": { - "smithy.api#documentation": "

The self-service action definition. Can be one of the following:

\n
\n
Name
\n
\n

The name of the AWS Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

\n

If you are using a shared SSM document, you must provide the ARN instead of the name.

\n
\n
Version
\n
\n

The AWS Systems Manager automation document version. For example, \"Version\": \"1\"\n

\n
\n
AssumeRole
\n
\n

The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, \"AssumeRole\": \"arn:aws:iam::12345678910:role/ActionRole\".

\n

To reuse the provisioned product launch role, set to \"AssumeRole\": \"LAUNCH_ROLE\".

\n
\n
Parameters
\n
\n

The list of parameters in JSON format.

\n

For example: [{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TARGET\\\"}] or [{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TEXT_VALUE\\\"}].

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

The self-service action definition. Can be one of the following:

\n
\n
Name
\n
\n

The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

\n

If you are using a shared SSM document, you must provide the ARN instead of the name.

\n
\n
Version
\n
\n

The Amazon Web Services Systems Manager automation document version. For example, \"Version\": \"1\"\n

\n
\n
AssumeRole
\n
\n

The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, \"AssumeRole\": \"arn:aws:iam::12345678910:role/ActionRole\".

\n

To reuse the provisioned product launch role, set to \"AssumeRole\": \"LAUNCH_ROLE\".

\n
\n
Parameters
\n
\n

The list of parameters in JSON format.

\n

For example: [{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TARGET\\\"}] or [{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TEXT_VALUE\\\"}].

\n
\n
", "smithy.api#required": {} } }, @@ -2012,7 +2012,7 @@ "AccountId": { "target": "com.amazonaws.servicecatalog#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID.

" + "smithy.api#documentation": "

The Amazon Web Services account ID.

" } }, "OrganizationNode": { @@ -2121,7 +2121,7 @@ "IgnoreErrors": { "target": "com.amazonaws.servicecatalog#IgnoreErrors", "traits": { - "smithy.api#documentation": "

If set to true, AWS Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.

" + "smithy.api#documentation": "

If set to true, Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.

" } } } @@ -3030,7 +3030,7 @@ "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

The URL of the CloudFormation template in Amazon S3.

" + "smithy.api#documentation": "

The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.

" } }, "Status": { @@ -3138,7 +3138,7 @@ "ProvisioningArtifactPreferences": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactPreferences", "traits": { - "smithy.api#documentation": "

An object that contains information about preferences, such as regions and accounts, for the provisioning artifact.

" + "smithy.api#documentation": "

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

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

Disable portfolio sharing through AWS Organizations feature. This feature will not\n delete your current shares but it will prevent you from creating new shares throughout your\n organization. Current shares will not be in sync with your organization structure if it\n changes after calling this API. This API can only be called by the management account in\n the organization.

\n

This API can't be invoked if there are active delegated administrators in the organization.

\n

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

" + "smithy.api#documentation": "

Disable portfolio sharing through the Organizations service. This command will not\n delete your current shares, but prevents you from creating new shares throughout your\n organization. Current shares are not kept in sync with your organization structure if the structure\n changes after calling this API. Only the management account in the organization can call this API.

\n

You cannot call this API if there are active delegated administrators in the organization.

\n

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

\n \n

If you share an Service Catalog portfolio in an organization within \n Organizations, and then disable Organizations access for Service Catalog, \n the portfolio access permissions will not sync with the latest changes to the organization \n structure. Specifically, accounts that you removed from the organization after \n disabling Service Catalog access will retain access to the previously shared portfolio.

\n " } }, "com.amazonaws.servicecatalog#DisableAWSOrganizationsAccessInput": { @@ -3682,7 +3682,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enable portfolio sharing feature through AWS Organizations. This API will allow Service\n Catalog to receive updates on your organization in order to sync your shares with the\n current structure. This API can only be called by the management account in the\n organization.

\n

By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

\n

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

" + "smithy.api#documentation": "

Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the\n current structure. This API can only be called by the management account in the organization.

\n

When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.

\n

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

\n \n

If you have previously disabled Organizations access for Service Catalog, and then \n enable access again, the portfolio access permissions might not sync with the latest changes to \n the organization structure. Specifically, accounts that you removed from the organization after \n disabling Service Catalog access, and before you enabled access again, can retain access to the \n previously shared portfolio. As a result, an account that has been removed from the organization \n might still be able to create or manage Amazon Web Services resources when it is no longer \n authorized to do so. Amazon Web Services is working to resolve this issue.

\n " } }, "com.amazonaws.servicecatalog#EnableAWSOrganizationsAccessInput": { @@ -3843,7 +3843,7 @@ "Parameters": { "target": "com.amazonaws.servicecatalog#ExecutionParameterMap", "traits": { - "smithy.api#documentation": "

A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will \n override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for \n any special parameters such as TARGET.

" + "smithy.api#documentation": "

A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will \n override the default value generated by Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for \n any special parameters such as TARGET.

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

Get the Access Status for AWS Organization portfolio share feature. This API can only be\n called by the management account in the organization or by a delegated admin.

" + "smithy.api#documentation": "

Get the Access Status for Organizations portfolio share feature. This API can only be\n called by the management account in the organization or by a delegated admin.

" } }, "com.amazonaws.servicecatalog#GetAWSOrganizationsAccessStatusInput": { @@ -4162,7 +4162,7 @@ } ], "traits": { - "smithy.api#documentation": "

Requests the import of a resource as a Service Catalog provisioned product that is\n associated to a Service Catalog product and provisioning artifact. Once imported, all\n supported Service Catalog governance actions are supported on the provisioned\n product.

\n

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and\n non-root nested stacks are not supported.

\n

The CloudFormation stack must have one of the following statuses to be imported:\n CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE,\n IMPORT_ROLLBACK_COMPLETE.

\n

Import of the resource requires that the CloudFormation stack template matches the\n associated Service Catalog product provisioning artifact.

\n \n

The user or role that performs this operation must have the cloudformation:GetTemplate\n and cloudformation:DescribeStacks IAM policy permissions.

" + "smithy.api#documentation": "

Requests the import of a resource as a Amazon Web Services Service Catalog provisioned product that is\n associated to a Amazon Web Services Service Catalog product and provisioning artifact. Once imported, all\n supported Amazon Web Services Service Catalog governance actions are supported on the provisioned\n product.

\n

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and\n non-root nested stacks are not supported.

\n

The CloudFormation stack must have one of the following statuses to be imported:\n CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE,\n IMPORT_ROLLBACK_COMPLETE.

\n

Import of the resource requires that the CloudFormation stack template matches the\n associated Amazon Web Services Service Catalog product provisioning artifact.

\n \n

The user or role that performs this operation must have the cloudformation:GetTemplate\n and cloudformation:DescribeStacks IAM policy permissions.

" } }, "com.amazonaws.servicecatalog#ImportAsProvisionedProductInput": { @@ -4191,7 +4191,7 @@ "ProvisionedProductName": { "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

The user-friendly name of the provisioned product. The value must be unique for the AWS\n account. The name cannot be updated after the product is provisioned.

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

The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned.

", "smithy.api#required": {} } }, @@ -4771,7 +4771,7 @@ "AccountIds": { "target": "com.amazonaws.servicecatalog#AccountIds", "traits": { - "smithy.api#documentation": "

Information about the AWS accounts with access to the portfolio.

" + "smithy.api#documentation": "

Information about the Amazon Web Services accounts with access to the portfolio.

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

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific AWS account name or region.

" + "smithy.api#documentation": "

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

" } }, "com.amazonaws.servicecatalog#ListStackInstancesForProvisionedProductInput": { @@ -6326,7 +6326,7 @@ "Type": { "target": "com.amazonaws.servicecatalog#ProductType", "traits": { - "smithy.api#documentation": "

The product type. Contact the product administrator for the significance of this\n value. If this value is MARKETPLACE, the product was created by AWS\n Marketplace.

" + "smithy.api#documentation": "

The product type. Contact the product administrator for the significance of this\n value. If this value is MARKETPLACE, the product was created by Amazon Web Services Marketplace.

" } }, "Distributor": { @@ -6475,7 +6475,7 @@ "ProvisionedProductName": { "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.

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

A user-friendly name for the provisioned product. This value must be\n unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

", "smithy.api#required": {} } }, @@ -7123,7 +7123,7 @@ "Type": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", "traits": { - "smithy.api#documentation": "

The type of provisioning artifact.

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

The type of provisioning artifact.

\n " } }, "CreatedTime": { @@ -7298,18 +7298,18 @@ "StackSetAccounts": { "target": "com.amazonaws.servicecatalog#StackSetAccounts", "traits": { - "smithy.api#documentation": "

One or more AWS accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.

\n

Applicable only to a CFN_STACKSET provisioned product type.

" + "smithy.api#documentation": "

One or more Amazon Web Services accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.

\n

Applicable only to a CFN_STACKSET provisioned product type.

" } }, "StackSetRegions": { "target": "com.amazonaws.servicecatalog#StackSetRegions", "traits": { - "smithy.api#documentation": "

One or more AWS Regions where stack instances are deployed from the stack set. These regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.

\n

Applicable only to a CFN_STACKSET provisioned product type.

" + "smithy.api#documentation": "

One or more Amazon Web Services Regions where stack instances are deployed from the stack set. These Regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.

\n

Applicable only to a CFN_STACKSET provisioned product type.

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

The user-defined preferences that will be applied during product provisioning, unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences.

\n

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options in the AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

The user-defined preferences that will be applied during product provisioning, unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences.

\n

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options in the CloudFormation User Guide.

" } }, "com.amazonaws.servicecatalog#ProvisioningArtifactProperties": { @@ -7330,20 +7330,20 @@ "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

Specify the template source with one of the following options, but not both.\n Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

\n

The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:

\n

\n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"\n

\n

\n ImportFromPhysicalId: The physical id of the resource that contains the\n template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON\n format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]\n

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

Specify the template source with one of the following options, but not both.\n Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

\n

The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.\n Specify the URL in JSON format as follows:

\n

\n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"\n

\n

\n ImportFromPhysicalId: The physical id of the resource that contains the\n template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON\n format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]\n

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", "traits": { - "smithy.api#documentation": "

The type of provisioning artifact.

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

The type of provisioning artifact.

\n " } }, "DisableTemplateValidation": { "target": "com.amazonaws.servicecatalog#DisableTemplateValidation", "traits": { - "smithy.api#documentation": "

If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

" + "smithy.api#documentation": "

If set to true, Amazon Web Services Service Catalog stops validating the specified provisioning artifact even if it is invalid.

" } } }, @@ -7401,7 +7401,7 @@ "ProvisioningArtifactMetadata": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

The metadata for the provisioning artifact. This is used with AWS Marketplace products.

" + "smithy.api#documentation": "

The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.

" } } }, @@ -7492,25 +7492,25 @@ "StackSetAccounts": { "target": "com.amazonaws.servicecatalog#StackSetAccounts", "traits": { - "smithy.api#documentation": "

One or more AWS accounts where the provisioned product will be available.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The specified accounts should be within the list of accounts from the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all acounts from the STACKSET constraint.

" + "smithy.api#documentation": "

One or more Amazon Web Services accounts where the provisioned product will be available.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The specified accounts should be within the list of accounts from the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all acounts from the STACKSET constraint.

" } }, "StackSetRegions": { "target": "com.amazonaws.servicecatalog#StackSetRegions", "traits": { - "smithy.api#documentation": "

One or more AWS Regions where the provisioned product will be available.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all regions from the STACKSET constraint.

" + "smithy.api#documentation": "

One or more Amazon Web Services Regions where the provisioned product will be available.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all Regions from the STACKSET constraint.

" } }, "StackSetFailureToleranceCount": { "target": "com.amazonaws.servicecatalog#StackSetFailureToleranceCount", "traits": { - "smithy.api#documentation": "

The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

\n

The default value is 0 if no value is specified.

" + "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

\n

The default value is 0 if no value is specified.

" } }, "StackSetFailureTolerancePercentage": { "target": "com.amazonaws.servicecatalog#StackSetFailureTolerancePercentage", "traits": { - "smithy.api#documentation": "

The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

\n

When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

" + "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

\n

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

" } }, "StackSetMaxConcurrencyCount": { @@ -7522,12 +7522,12 @@ "StackSetMaxConcurrencyPercentage": { "target": "com.amazonaws.servicecatalog#StackSetMaxConcurrencyPercentage", "traits": { - "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one time.

\n

When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

\n

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

" + "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one time.

\n

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

\n

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

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

The user-defined preferences that will be applied when updating a provisioned\n product. Not all preferences are applicable to all provisioned product type

\n

One or more AWS accounts that will have access to the provisioned product.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The AWS accounts specified should be within the list of accounts in the\n STACKSET constraint. To get the list of accounts in the\n STACKSET constraint, use the DescribeProvisioningParameters\n operation.

\n

If no values are specified, the default value is all accounts from the\n STACKSET constraint.

" + "smithy.api#documentation": "

The user-defined preferences that will be applied when updating a provisioned\n product. Not all preferences are applicable to all provisioned product type

\n

One or more Amazon Web Services accounts that will have access to the provisioned product.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The Amazon Web Services accounts specified should be within the list of accounts in the\n STACKSET constraint. To get the list of accounts in the\n STACKSET constraint, use the DescribeProvisioningParameters\n operation.

\n

If no values are specified, the default value is all accounts from the\n STACKSET constraint.

" } }, "com.amazonaws.servicecatalog#RecordDetail": { @@ -8380,7 +8380,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the provisioned products that meet the specified criteria.

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

Gets information about the provisioned products that meet the specified criteria.

\n \n \n

To ensure a complete list of provisioned products and remove duplicate products, use\n sort-by createdTime.

\n

Here is a CLI example: \n

\n

\n aws servicecatalog search-provisioned-products --sort-by createdTime \n

\n ", "smithy.api#paginated": { "inputToken": "PageToken", "outputToken": "NextPageToken", @@ -8797,13 +8797,13 @@ "Account": { "target": "com.amazonaws.servicecatalog#AccountId", "traits": { - "smithy.api#documentation": "

The name of the AWS account that the stack instance is associated with.

" + "smithy.api#documentation": "

The name of the Amazon Web Services account that the stack instance is associated with.

" } }, "Region": { "target": "com.amazonaws.servicecatalog#Region", "traits": { - "smithy.api#documentation": "

The name of the AWS region that the stack instance is associated with.

" + "smithy.api#documentation": "

The name of the Amazon Web Services Region that the stack instance is associated with.

" } }, "StackInstanceStatus": { @@ -8814,7 +8814,7 @@ } }, "traits": { - "smithy.api#documentation": "

An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

" + "smithy.api#documentation": "

An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

" } }, "com.amazonaws.servicecatalog#StackInstanceStatus": { @@ -9049,7 +9049,7 @@ "Owner": { "target": "com.amazonaws.servicecatalog#Owner", "traits": { - "smithy.api#documentation": "

The AWS account Id of the owner account that created the TagOption.

" + "smithy.api#documentation": "

The Amazon Web Services account Id of the owner account that created the TagOption.

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

An operation requiring TagOptions failed because the TagOptions migration process has\n not been performed for this account. Please use the AWS console to perform the migration\n process before retrying the operation.

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

An operation requiring TagOptions failed because the TagOptions migration process has\n not been performed for this account. Use the Amazon Web Services Management Console to perform the migration\n process before retrying the operation.

", "smithy.api#error": "client" } }, @@ -9201,7 +9201,7 @@ "IgnoreErrors": { "target": "com.amazonaws.servicecatalog#IgnoreErrors", "traits": { - "smithy.api#documentation": "

If set to true, AWS Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.

" + "smithy.api#documentation": "

If set to true, Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.

" } }, "AcceptLanguage": { @@ -9277,7 +9277,7 @@ "Parameters": { "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { - "smithy.api#documentation": "

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

\n
\n
LAUNCH
\n
\n

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

\n

Specify the RoleArn property as follows:

\n

\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

\n

Specify the LocalRoleName property as follows:

\n

\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

\n

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

\n \n

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

\n \n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one LAUNCH constraint on a product and portfolio.

\n
\n
NOTIFICATION
\n
\n

Specify the NotificationArns property as follows:

\n

\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

\n
\n
RESOURCE_UPDATE
\n
\n

Specify the TagUpdatesOnProvisionedProduct property as follows:

\n

\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

\n

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

\n
\n
STACKSET
\n
\n

Specify the Parameters property as follows:

\n

\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

\n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one STACKSET constraint on a product and portfolio.

\n

Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

\n
\n
TEMPLATE
\n
\n

Specify the Rules property. For more information, see\n Template Constraint Rules.

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

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

\n
\n
LAUNCH
\n
\n

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

\n

Specify the RoleArn property as follows:

\n

\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

\n

Specify the LocalRoleName property as follows:

\n

\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

\n

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

\n \n

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

\n \n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one LAUNCH constraint on a product and portfolio.

\n
\n
NOTIFICATION
\n
\n

Specify the NotificationArns property as follows:

\n

\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

\n
\n
RESOURCE_UPDATE
\n
\n

Specify the TagUpdatesOnProvisionedProduct property as follows:

\n

\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

\n

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

\n
\n
STACKSET
\n
\n

Specify the Parameters property as follows:

\n

\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

\n

You cannot have both a LAUNCH and a STACKSET constraint.

\n

You also cannot have more than one STACKSET constraint on a product and portfolio.

\n

Products with a STACKSET constraint will launch an CloudFormation stack set.

\n
\n
TEMPLATE
\n
\n

Specify the Rules property. For more information, see\n Template Constraint Rules.

\n
\n
" } } } @@ -9441,7 +9441,7 @@ "AccountId": { "target": "com.amazonaws.servicecatalog#AccountId", "traits": { - "smithy.api#documentation": "

The AWS Account Id of the recipient account. This field is required when updating an external account to account type share.

" + "smithy.api#documentation": "

The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

" } }, "OrganizationNode": { @@ -9742,7 +9742,7 @@ "ProvisionedProductProperties": { "target": "com.amazonaws.servicecatalog#ProvisionedProductProperties", "traits": { - "smithy.api#documentation": "

A map that contains the provisioned product properties to be updated.

\n

The LAUNCH_ROLE key accepts role ARNs. This key allows an\n administrator to call UpdateProvisionedProductProperties to update the launch\n role that is associated with a provisioned product. This role is used when an end user\n calls a provisioning operation such as UpdateProvisionedProduct,\n TerminateProvisionedProduct, or\n ExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.

\n\n

The OWNER key accepts user ARNs and role ARNs. The owner is the user\n that has permission to see, update, terminate, and execute service actions in the\n provisioned product.

\n

The administrator can change the owner of a provisioned product to another IAM user within the same account. Both end user owners and \n administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can \n describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, \n but can still see the product's history from when he was an owner using ListRecordHistory.

\n

If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or \n Service Catalog console such as update, terminate, and execute service actions. \n If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through \n API or the Service Catalog console on that provisioned product.

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

A map that contains the provisioned product properties to be updated.

\n

The LAUNCH_ROLE key accepts role ARNs. This key allows an\n administrator to call UpdateProvisionedProductProperties to update the launch\n role that is associated with a provisioned product. This role is used when an end user\n calls a provisioning operation such as UpdateProvisionedProduct,\n TerminateProvisionedProduct, or\n ExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.

\n\n

The OWNER key accepts IAM user ARNs, IAM role ARNs, and STS \n assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and \n execute service actions in the provisioned product.

\n

The administrator can change the owner of a provisioned product to another IAM or STS entity within the \n same account. Both end user owners and administrators can see ownership history of the provisioned \n product using the ListRecordHistory API. The new owner can describe all past records \n for the provisioned product using the DescribeRecord API. The previous owner can no \n longer use DescribeRecord, but can still see the product's history from when he was \n an owner using ListRecordHistory.

\n

If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or \n Service Catalog console such as update, terminate, and execute service actions. \n If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through \n API or the Service Catalog console on that provisioned product.

", "smithy.api#required": {} } }, @@ -9866,7 +9866,7 @@ "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

The URL of the CloudFormation template in Amazon S3.

" + "smithy.api#documentation": "

The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.

" } }, "Status": { @@ -9915,25 +9915,25 @@ "StackSetAccounts": { "target": "com.amazonaws.servicecatalog#StackSetAccounts", "traits": { - "smithy.api#documentation": "

One or more AWS accounts that will have access to the provisioned product.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all accounts from the STACKSET constraint.

" + "smithy.api#documentation": "

One or more Amazon Web Services accounts that will have access to the provisioned product.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all accounts from the STACKSET constraint.

" } }, "StackSetRegions": { "target": "com.amazonaws.servicecatalog#StackSetRegions", "traits": { - "smithy.api#documentation": "

One or more AWS Regions where the provisioned product will be available.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all regions from the STACKSET constraint.

" + "smithy.api#documentation": "

One or more Amazon Web Services Regions where the provisioned product will be available.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all Regions from the STACKSET constraint.

" } }, "StackSetFailureToleranceCount": { "target": "com.amazonaws.servicecatalog#StackSetFailureToleranceCount", "traits": { - "smithy.api#documentation": "

The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

\n

The default value is 0 if no value is specified.

" + "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

\n

The default value is 0 if no value is specified.

" } }, "StackSetFailureTolerancePercentage": { "target": "com.amazonaws.servicecatalog#StackSetFailureTolerancePercentage", "traits": { - "smithy.api#documentation": "

The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

\n

When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

" + "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

\n

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

" } }, "StackSetMaxConcurrencyCount": { @@ -9945,13 +9945,13 @@ "StackSetMaxConcurrencyPercentage": { "target": "com.amazonaws.servicecatalog#StackSetMaxConcurrencyPercentage", "traits": { - "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one time.

\n

When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

\n

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

" + "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one time.

\n

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

\n

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

" } }, "StackSetOperationType": { "target": "com.amazonaws.servicecatalog#StackSetOperationType", "traits": { - "smithy.api#documentation": "

Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n
\n
CREATE
\n
\n

Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

\n
\n
UPDATE
\n
\n

Updates the stack set represented by the provisioned product and also its stack instances.

\n
\n
DELETE
\n
\n

Deletes a stack instance in the stack set represented by the provisioned product.

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

Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n
\n
CREATE
\n
\n

Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

\n
\n
UPDATE
\n
\n

Updates the stack set represented by the provisioned product and also its stack instances.

\n
\n
DELETE
\n
\n

Deletes a stack instance in the stack set represented by the provisioned product.

\n
\n
" } } }, diff --git a/codegen/sdk/aws-models/sso-admin.json b/codegen/sdk/aws-models/sso-admin.json index 46f653e96fe..ceffba7a520 100644 --- a/codegen/sdk/aws-models/sso-admin.json +++ b/codegen/sdk/aws-models/sso-admin.json @@ -35,7 +35,7 @@ "Key": { "target": "com.amazonaws.ssoadmin#AccessControlAttributeKey", "traits": { - "smithy.api#documentation": "

The name of the attribute associated with your identities in your identity source. This is\n used to map a specified attribute in your identity source with an attribute in Amazon Web Services\n SSO.

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

The name of the attribute associated with your identities in your identity source. This is\n used to map a specified attribute in your identity source with an attribute in\n Amazon Web Services SSO.

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

These are Amazon Web Services SSO identity store attributes that you can configure for use in\n attributes-based access control (ABAC). You can create permissions policies that determine who\n can access your Amazon Web Services resources based upon the configured attribute values. When you enable\n ABAC and specify AccessControlAttributes, Amazon Web Services SSO passes the attribute values\n of the authenticated user into IAM for use in policy evaluation.

" + "smithy.api#documentation": "

These are Amazon Web Services SSO identity store attributes that you can configure for use in\n attributes-based access control (ABAC). You can create permissions policies that determine who\n can access your Amazon Web Services resources based upon the configured attribute values. When you enable\n ABAC and specify AccessControlAttributes, Amazon Web Services SSO passes the attribute values of\n the authenticated user into IAM for use in policy evaluation.

" } }, "com.amazonaws.ssoadmin#AccessControlAttributeKey": { @@ -85,7 +85,7 @@ } }, "traits": { - "smithy.api#documentation": "

The value used for mapping a specified attribute to an identity source. For more information, see Attribute mappings in the Amazon Web Services Single Sign-On User Guide.

" + "smithy.api#documentation": "

The value used for mapping a specified attribute to an identity source. For more\n information, see Attribute mappings\n in the Amazon Web Services SSO User Guide.

" } }, "com.amazonaws.ssoadmin#AccessControlAttributeValueSource": { @@ -306,7 +306,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches the specified IAM customer managed policy to the specified PermissionSet.

" + "smithy.api#documentation": "

Attaches the specified customer managed policy to the specified PermissionSet.

" } }, "com.amazonaws.ssoadmin#AttachCustomerManagedPolicyReferenceToPermissionSetRequest": { @@ -315,7 +315,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, @@ -329,7 +329,7 @@ "CustomerManagedPolicyReference": { "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReference", "traits": { - "smithy.api#documentation": "

Specifies the name and path of the IAM customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

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

Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

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

Attaches an Amazon Web Services managed IAM policy ARN to a permission set.

\n \n

If the permission set is already referenced by one or more account assignments, you will\n need to call \n ProvisionPermissionSet\n after this operation.\n Calling ProvisionPermissionSet applies the corresponding IAM policy updates to\n all assigned accounts.

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

Attaches an Amazon Web Services managed policy ARN to a permission set.

\n \n

If the permission set is already referenced by one or more account assignments, you will\n need to call \n ProvisionPermissionSet\n after this operation.\n Calling ProvisionPermissionSet applies the corresponding IAM policy updates\n to all assigned accounts.

\n " } }, "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSetRequest": { @@ -380,7 +380,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -410,18 +410,18 @@ "Name": { "target": "com.amazonaws.ssoadmin#Name", "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services managed IAM policy.

" + "smithy.api#documentation": "

The name of the Amazon Web Services managed policy.

" } }, "Arn": { "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Web Services managed IAM policy. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the Amazon Web Services managed policy. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

A structure that stores the details of the Amazon Web Services managed IAM policy.

" + "smithy.api#documentation": "

A structure that stores the details of the Amazon Web Services managed policy.

" } }, "com.amazonaws.ssoadmin#AttachedManagedPolicyList": { @@ -478,7 +478,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns access to a principal for a specified Amazon Web Services account using a specified permission\n set.

\n \n

The term principal here refers to a user or group that is defined\n in Amazon Web Services SSO.

\n \n \n

As part of a successful CreateAccountAssignment call, the specified\n permission set will automatically be provisioned to the account in the form of an IAM\n policy. That policy is attached to the SSO-created IAM role. If the permission set is\n subsequently updated, the corresponding IAM policies attached to roles in your accounts will\n not be updated automatically. In this case, you must call \n ProvisionPermissionSet\n to make these updates.

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

Assigns access to a principal for a specified Amazon Web Services account using a specified\n permission set.

\n \n

The term principal here refers to a user or group that is defined\n in Amazon Web Services SSO.

\n \n \n

As part of a successful CreateAccountAssignment call, the specified\n permission set will automatically be provisioned to the account in the form of an IAM\n policy. That policy is attached to the IAM role created in Amazon Web Services SSO. If the permission set\n is subsequently updated, the corresponding IAM policies attached to roles in your accounts\n will not be updated automatically. In this case, you must call \n ProvisionPermissionSet\n to make these updates.

\n " } }, "com.amazonaws.ssoadmin#CreateAccountAssignmentRequest": { @@ -487,7 +487,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -577,14 +577,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, "InstanceAccessControlAttributeConfiguration": { "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services SSO identity store attributes to add to your ABAC configuration.\n When using an external identity provider as an identity source, you can pass attributes\n through the SAML assertion. Doing so provides an alternative to configuring attributes from\n the Amazon Web Services SSO identity store. If a SAML assertion passes any of these attributes, Amazon Web Services\n SSO will replace the attribute value with the value from the Amazon Web Services SSO identity\n store.

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

Specifies the Amazon Web Services SSO identity store attributes to add to your ABAC configuration. When\n using an external identity provider as an identity source, you can pass attributes through the\n SAML assertion. Doing so provides an alternative to configuring attributes from the Amazon Web Services SSO\n identity store. If a SAML assertion passes any of these attributes, Amazon Web Services SSO will replace the\n attribute value with the value from the Amazon Web Services SSO identity store.

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

Creates a permission set within a specified SSO instance.

\n \n

To grant users and groups access to Amazon Web Services account resources, use \n CreateAccountAssignment\n .

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

Creates a permission set within a specified Amazon Web Services SSO instance.

\n \n

To grant users and groups access to Amazon Web Services account resources, use \n CreateAccountAssignment\n .

\n " } }, "com.amazonaws.ssoadmin#CreatePermissionSetRequest": { @@ -648,7 +648,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -689,19 +689,19 @@ "Name": { "target": "com.amazonaws.ssoadmin#ManagedPolicyName", "traits": { - "smithy.api#documentation": "

The name of the policy document.

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

The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

", "smithy.api#required": {} } }, "Path": { "target": "com.amazonaws.ssoadmin#ManagedPolicyPath", "traits": { - "smithy.api#documentation": "

The path for the policy. The default is /. For more information, see Friendly names and paths in the Identity and Access Management user guide.

" + "smithy.api#documentation": "

The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly\n names and paths in the Identity and Access Management User\n Guide.

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

Specifies the name and path of the IAM customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

" + "smithy.api#documentation": "

Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

" } }, "com.amazonaws.ssoadmin#CustomerManagedPolicyReferenceList": { @@ -751,7 +751,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -841,7 +841,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -896,7 +896,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } } @@ -944,7 +944,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -996,7 +996,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, @@ -1048,7 +1048,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -1107,7 +1107,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Returns the list of Amazon Web Services SSO identity store attributes that have been configured to\n work with attributes-based access control (ABAC) for the specified Amazon Web Services SSO instance. This\n will not return attributes configured and sent by an external identity provider.\n For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide.

" + "smithy.api#documentation": "

Returns the list of Amazon Web Services SSO identity store attributes that have been configured to work\n with attributes-based access control (ABAC) for the specified Amazon Web Services SSO instance. This will not\n return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide.

" } }, "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationRequest": { @@ -1166,7 +1166,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } } @@ -1259,7 +1259,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -1289,14 +1289,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the permission set.

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

The ARN of the permission set.

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

Detaches the specified IAM customer managed policy from the specified PermissionSet.

" + "smithy.api#documentation": "

Detaches the specified customer managed policy from the specified PermissionSet.

" } }, "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetRequest": { @@ -1351,7 +1351,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, @@ -1365,7 +1365,7 @@ "CustomerManagedPolicyReference": { "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReference", "traits": { - "smithy.api#documentation": "

Specifies the name and path of the IAM customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

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

Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

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

Detaches the attached Amazon Web Services managed IAM policy ARN from the specified permission set.

" + "smithy.api#documentation": "

Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.

" } }, "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest": { @@ -1413,7 +1413,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -1482,7 +1482,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -1501,7 +1501,7 @@ "InlinePolicy": { "target": "com.amazonaws.ssoadmin#PermissionSetPolicyDocument", "traits": { - "smithy.api#documentation": "

The IAM inline policy that is attached to the permission set.

" + "smithy.api#documentation": "

The inline policy that is attached to the permission set.

" } } } @@ -1541,7 +1541,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, @@ -1634,18 +1634,18 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "IdentityStoreId": { "target": "com.amazonaws.ssoadmin#Id", "traits": { - "smithy.api#documentation": "

The identifier of the identity store that is connected to the SSO instance.

" + "smithy.api#documentation": "

The identifier of the identity store that is connected to the Amazon Web Services SSO instance.

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

Provides information about the SSO instance.

" + "smithy.api#documentation": "

Provides information about the Amazon Web Services SSO instance.

" } }, "com.amazonaws.ssoadmin#InternalFailureMessage": { @@ -1690,7 +1690,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the status of the Amazon Web Services account assignment creation requests for a specified SSO\n instance.

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

Lists the status of the Amazon Web Services account assignment creation requests for a specified Amazon Web Services SSO\n instance.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1705,7 +1705,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Lists the status of the Amazon Web Services account assignment deletion requests for a specified SSO\n instance.

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

Lists the status of the Amazon Web Services account assignment deletion requests for a specified Amazon Web Services SSO\n instance.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1787,7 +1787,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Lists the assignee of the specified Amazon Web Services account with the specified permission\n set.

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

Lists the assignee of the specified Amazon Web Services account with the specified permission set.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1869,7 +1869,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -1959,7 +1959,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Lists all IAM customer managed policies attached to a specified PermissionSet.

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

Lists all customer managed policies attached to a specified PermissionSet.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2048,14 +2048,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the PermissionSet.

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

The ARN of the PermissionSet.

", "smithy.api#required": {} } }, @@ -2068,7 +2068,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

" + "smithy.api#documentation": "

The pagination token for the list API. Initially the value is null. Use the output of\n previous API calls to make subsequent calls.

" } } } @@ -2079,13 +2079,13 @@ "CustomerManagedPolicyReferences": { "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReferenceList", "traits": { - "smithy.api#documentation": "

Specifies the names and paths of the IAM customer managed policies that you have attached to your permission set.

" + "smithy.api#documentation": "

Specifies the names and paths of the customer managed policies that you have attached to\n your permission set.

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

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

" + "smithy.api#documentation": "

The pagination token for the list API. Initially the value is null. Use the output of\n previous API calls to make subsequent calls.

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

Lists the SSO instances that the caller has access to.

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

Lists the Amazon Web Services SSO instances that the caller has access to.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2145,7 +2145,7 @@ "Instances": { "target": "com.amazonaws.ssoadmin#InstanceList", "traits": { - "smithy.api#documentation": "

Lists the SSO instances that the caller has access to.

" + "smithy.api#documentation": "

Lists the Amazon Web Services SSO instances that the caller has access to.

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

Lists the Amazon Web Services managed IAM policy that is attached to a specified permission set.

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

Lists the Amazon Web Services managed policy that is attached to a specified permission set.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2197,7 +2197,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2228,7 +2228,7 @@ "AttachedManagedPolicies": { "target": "com.amazonaws.ssoadmin#AttachedManagedPolicyList", "traits": { - "smithy.api#documentation": "

The array of the AttachedManagedPolicy data type object.

" + "smithy.api#documentation": "

An array of the AttachedManagedPolicy data type object.

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

Lists the status of the permission set provisioning requests for a specified SSO\n instance.

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

Lists the status of the permission set provisioning requests for a specified Amazon Web Services SSO\n instance.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2280,7 +2280,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Lists the PermissionSets in an SSO instance.

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

Lists the PermissionSets in an Amazon Web Services SSO instance.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2397,7 +2397,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2451,7 +2451,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2526,7 +2526,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2797,18 +2797,18 @@ "CustomerManagedPolicyReference": { "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReference", "traits": { - "smithy.api#documentation": "

Specifies the name and path of the IAM customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

" + "smithy.api#documentation": "

Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

" } }, "ManagedPolicyArn": { "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", "traits": { - "smithy.api#documentation": "

The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary.

" + "smithy.api#documentation": "

The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions\n boundary.

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

Specifies the configuration of the Amazon Web Services managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference \n to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an Amazon Web Services managed IAM policy. A permissions boundary represents the maximum permissions that any policy\n can grant your role. For more information, see Permissions boundaries for IAM entities in the Identity and Access Management User Guide.

\n \n

Policies used as permissions boundaries do not provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the Identity and Access Management User Guide.

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

Specifies the configuration of the Amazon Web Services managed or customer managed policy that you want\n to set as a permissions boundary. Specify either CustomerManagedPolicyReference\n to use the name and path of a customer managed policy, or ManagedPolicyArn to use\n the ARN of an Amazon Web Services managed policy. A permissions boundary represents the maximum permissions\n that any policy can grant your role. For more information, see Permissions boundaries for IAM\n entities in the Identity and Access Management User Guide.

\n \n

Policies used as permissions boundaries don't provide permissions. You must also attach\n an IAM policy to the role. To learn how the effective permissions for a role are\n evaluated, see IAM JSON policy\n evaluation logic in the Identity and Access Management User\n Guide.

\n " } }, "com.amazonaws.ssoadmin#PrincipalId": { @@ -2874,7 +2874,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Attaches an IAM inline policy to a permission set.

\n \n

If the permission set is already referenced by one or more account assignments, you will\n need to call \n ProvisionPermissionSet\n after this action to\n apply the corresponding IAM policy updates to all assigned accounts.

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

Attaches an inline policy to a permission set.

\n \n

If the permission set is already referenced by one or more account assignments, you will\n need to call \n ProvisionPermissionSet\n after this action to\n apply the corresponding IAM policy updates to all assigned accounts.

\n " } }, "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSetRequest": { @@ -2982,7 +2982,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2996,7 +2996,7 @@ "InlinePolicy": { "target": "com.amazonaws.ssoadmin#PermissionSetPolicyDocument", "traits": { - "smithy.api#documentation": "

The IAM inline policy to attach to a PermissionSet.

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

The inline policy to attach to a PermissionSet.

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

Attaches an Amazon Web Services managed or customer managed IAM policy to the specified PermissionSet as a permissions boundary.

" + "smithy.api#documentation": "

Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.

" } }, "com.amazonaws.ssoadmin#PutPermissionsBoundaryToPermissionSetRequest": { @@ -3044,7 +3044,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, @@ -3364,7 +3364,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -3503,7 +3503,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Updates the Amazon Web Services SSO identity store attributes that you can use with the Amazon Web Services SSO\n instance for attributes-based access control (ABAC). When using an external identity provider\n as an identity source, you can pass attributes through the SAML assertion as an alternative to\n configuring attributes from the Amazon Web Services SSO identity store. If a SAML assertion passes any of\n these attributes, Amazon Web Services SSO replaces the attribute value with the value from the Amazon Web Services SSO\n identity store. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide.

" + "smithy.api#documentation": "

Updates the Amazon Web Services SSO identity store attributes that you can use with the Amazon Web Services SSO instance\n for attributes-based access control (ABAC). When using an external identity provider as an\n identity source, you can pass attributes through the SAML assertion as an alternative to\n configuring attributes from the Amazon Web Services SSO identity store. If a SAML assertion passes any of\n these attributes, Amazon Web Services SSO replaces the attribute value with the value from the Amazon Web Services SSO\n identity store. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide.

" } }, "com.amazonaws.ssoadmin#UpdateInstanceAccessControlAttributeConfigurationRequest": { @@ -3565,7 +3565,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

", "smithy.api#required": {} } }, @@ -3620,7 +3620,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/sso-oidc.json b/codegen/sdk/aws-models/sso-oidc.json index 2947495ad7f..061ef55993a 100644 --- a/codegen/sdk/aws-models/sso-oidc.json +++ b/codegen/sdk/aws-models/sso-oidc.json @@ -31,18 +31,6 @@ "shapes": { "com.amazonaws.ssooidc#AWSSSOOIDCService": { "type": "service", - "version": "2019-06-10", - "operations": [ - { - "target": "com.amazonaws.ssooidc#CreateToken" - }, - { - "target": "com.amazonaws.ssooidc#RegisterClient" - }, - { - "target": "com.amazonaws.ssooidc#StartDeviceAuthorization" - } - ], "traits": { "aws.api#service": { "sdkId": "SSO OIDC", @@ -55,9 +43,21 @@ "name": "awsssooidc" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client\n (such as AWS CLI or a native application) to register with AWS SSO. The service also\n enables the client to fetch the user’s access token upon successful authentication and\n authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of\n the device authorization grant standard (https://tools.ietf.org/html/rfc8628).

\n \n

For general information about AWS SSO, see What is AWS\n Single Sign-On? in the AWS SSO User Guide.

\n \n

This API reference guide describes the AWS SSO OIDC operations that you can call\n programatically and includes detailed information on data types and errors.

\n \n \n

AWS provides SDKs that consist of libraries and sample code for various programming\n languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a\n convenient way to create programmatic access to AWS SSO and other AWS services. For more\n information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

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

Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI\n or a native application) to register with Amazon Web Services SSO. The service also enables the client to\n fetch the user’s access token upon successful authentication and authorization with\n Amazon Web Services SSO.

\n \n

Although Amazon Web Services 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 Amazon Web Services SSO 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 Amazon Web Services SSO OIDC service works.

\n \n\n

For general information about Amazon Web Services SSO, see What is\n Amazon Web Services SSO? in the Amazon Web Services SSO User Guide.

", "smithy.api#title": "AWS SSO OIDC" - } + }, + "version": "2019-06-10", + "operations": [ + { + "target": "com.amazonaws.ssooidc#CreateToken" + }, + { + "target": "com.amazonaws.ssooidc#RegisterClient" + }, + { + "target": "com.amazonaws.ssooidc#StartDeviceAuthorization" + } + ] }, "com.amazonaws.ssooidc#AccessDeniedException": { "type": "structure", @@ -92,7 +92,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates that a request to authorize a client with an access user session token is pending.

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

Indicates that a request to authorize a client with an access user session token is\n pending.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -154,7 +154,7 @@ ], "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 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 Amazon Web Services\n account.

", "smithy.api#http": { "method": "POST", "uri": "/token", @@ -169,21 +169,21 @@ "clientId": { "target": "com.amazonaws.ssooidc#ClientId", "traits": { - "smithy.api#documentation": "

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

", + "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#required": {} } }, "clientSecret": { "target": "com.amazonaws.ssooidc#ClientSecret", "traits": { - "smithy.api#documentation": "

A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

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

A secret string generated for the client. This value should come from the persisted result\n of the RegisterClient API.

", "smithy.api#required": {} } }, "grantType": { "target": "com.amazonaws.ssooidc#GrantType", "traits": { - "smithy.api#documentation": "

Supports grant types for authorization code, refresh token, and device code request.

", + "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

\n urn:ietf:params:oauth:grant-type:device_code\n \n

\n\n

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

", "smithy.api#required": {} } }, @@ -197,13 +197,13 @@ "code": { "target": "com.amazonaws.ssooidc#AuthCode", "traits": { - "smithy.api#documentation": "

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

" + "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.

" } }, "refreshToken": { "target": "com.amazonaws.ssooidc#RefreshToken", "traits": { - "smithy.api#documentation": "

The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

" + "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 Amazon Web Services SSO OIDC implementation,\n see Considerations for Using this Guide in the Amazon Web Services SSO\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.

" } }, "scope": { @@ -226,7 +226,7 @@ "accessToken": { "target": "com.amazonaws.ssooidc#AccessToken", "traits": { - "smithy.api#documentation": "

An opaque token to access AWS SSO resources assigned to a user.

" + "smithy.api#documentation": "

An opaque token to access Amazon Web Services SSO resources assigned to a user.

" } }, "tokenType": { @@ -244,13 +244,13 @@ "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.

" + "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 Amazon Web Services SSO OIDC implementation,\n see Considerations for Using this Guide in the Amazon Web Services SSO\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.

" } }, "idToken": { "target": "com.amazonaws.ssooidc#IdToken", "traits": { - "smithy.api#documentation": "

The identifier of the user that associated with the access token, if present.

" + "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 Amazon Web Services SSO OIDC implementation,\n see Considerations for Using this Guide in the Amazon Web Services SSO\n OIDC API Reference.

\n

The identifier of the user that associated with the access token, if present.

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

Indicates that an error from the service occurred while trying to process a request.

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

Indicates that an error from the service occurred while trying to process a\n request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -335,7 +335,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates that the client information sent in the request during registration is invalid.

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

Indicates that the client information sent in the request during registration is\n invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -351,7 +351,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type.

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

Indicates that a request contains an invalid grant. This can occur if a client makes a\n CreateToken request with an invalid grant type.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -418,7 +418,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Registers a client with AWS SSO. This allows clients to initiate device authorization.\n The output should be persisted for reuse through many authentication requests.

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

Registers a client with Amazon Web Services SSO. This allows clients to initiate device authorization.\n The output should be persisted for reuse through many authentication requests.

", "smithy.api#http": { "method": "POST", "uri": "/client/register", @@ -440,7 +440,7 @@ "clientType": { "target": "com.amazonaws.ssooidc#ClientType", "traits": { - "smithy.api#documentation": "

The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

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

The type of client. The service supports only public as a client type.\n Anything other than public will be rejected by the service.

", "smithy.api#required": {} } }, @@ -470,13 +470,13 @@ "clientIdIssuedAt": { "target": "com.amazonaws.ssooidc#LongTimeStampType", "traits": { - "smithy.api#documentation": "

Indicates the time at which the clientId and clientSecret were issued.

" + "smithy.api#documentation": "

Indicates the time at which the clientId and clientSecret were\n issued.

" } }, "clientSecretExpiresAt": { "target": "com.amazonaws.ssooidc#LongTimeStampType", "traits": { - "smithy.api#documentation": "

Indicates the time at which the clientId and clientSecret will become invalid.

" + "smithy.api#documentation": "

Indicates the time at which the clientId and clientSecret will\n become invalid.

" } }, "authorizationEndpoint": { @@ -513,7 +513,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates that the client is making the request too frequently and is more than the service can handle.

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

Indicates that the client is making the request too frequently and is more than the\n service can handle.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -545,7 +545,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Initiates device authorization by requesting a pair of verification codes from the authorization service.

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

Initiates device authorization by requesting a pair of verification codes from the\n authorization service.

", "smithy.api#http": { "method": "POST", "uri": "/device_authorization", @@ -560,7 +560,7 @@ "clientId": { "target": "com.amazonaws.ssooidc#ClientId", "traits": { - "smithy.api#documentation": "

The unique identifier string for the client that is registered with AWS SSO. This value\n should come from the persisted result of the RegisterClient API\n operation.

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

The unique identifier string for the client that is registered with Amazon Web Services SSO. This value\n should come from the persisted result of the RegisterClient API\n operation.

", "smithy.api#required": {} } }, @@ -574,7 +574,7 @@ "startUrl": { "target": "com.amazonaws.ssooidc#URI", "traits": { - "smithy.api#documentation": "

The URL for the AWS SSO user portal. For more information, see Using\n the User Portal in the AWS Single Sign-On User Guide.

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

The URL for the AWS access portal. For more information, see Using\n the AWS access portal in the Amazon Web Services SSO User Guide.

", "smithy.api#required": {} } } @@ -598,7 +598,7 @@ "verificationUri": { "target": "com.amazonaws.ssooidc#URI", "traits": { - "smithy.api#documentation": "

The URI of the verification page that takes the userCode to authorize the device.

" + "smithy.api#documentation": "

The URI of the verification page that takes the userCode to authorize the\n device.

" } }, "verificationUriComplete": { @@ -616,7 +616,7 @@ "interval": { "target": "com.amazonaws.ssooidc#IntervalInSeconds", "traits": { - "smithy.api#documentation": "

Indicates the number of seconds the client must wait between attempts when polling for a session.

" + "smithy.api#documentation": "

Indicates the number of seconds the client must wait between attempts when polling for a\n session.

" } } } diff --git a/codegen/sdk/aws-models/sso.json b/codegen/sdk/aws-models/sso.json index 87712aab140..2e61fa66730 100644 --- a/codegen/sdk/aws-models/sso.json +++ b/codegen/sdk/aws-models/sso.json @@ -47,24 +47,24 @@ "accountId": { "target": "com.amazonaws.sso#AccountIdType", "traits": { - "smithy.api#documentation": "

The identifier of the AWS account that is assigned to the user.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services account that is assigned to the user.

" } }, "accountName": { "target": "com.amazonaws.sso#AccountNameType", "traits": { - "smithy.api#documentation": "

The display name of the AWS account that is assigned to the user.

" + "smithy.api#documentation": "

The display name of the Amazon Web Services account that is assigned to the user.

" } }, "emailAddress": { "target": "com.amazonaws.sso#EmailAddressType", "traits": { - "smithy.api#documentation": "

The email address of the AWS account that is assigned to the user.

" + "smithy.api#documentation": "

The email address of the Amazon Web Services account that is assigned to the user.

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

Provides information about your AWS account.

" + "smithy.api#documentation": "

Provides information about your Amazon Web Services account.

" } }, "com.amazonaws.sso#AccountListType": { @@ -138,7 +138,7 @@ "accountId": { "target": "com.amazonaws.sso#AccountIdType", "traits": { - "smithy.api#documentation": "

The identifier for the AWS account that is assigned to the user.

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

The identifier for the Amazon Web Services account that is assigned to the user.

", "smithy.api#httpQuery": "account_id", "smithy.api#required": {} } @@ -146,7 +146,7 @@ "accessToken": { "target": "com.amazonaws.sso#AccessTokenType", "traits": { - "smithy.api#documentation": "

The token issued by the CreateToken API call. For more information, see\n CreateToken in the AWS SSO OIDC API Reference Guide.

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

The token issued by the CreateToken API call. For more information, see\n CreateToken in the Amazon Web Services SSO OIDC API Reference Guide.

", "smithy.api#httpHeader": "x-amz-sso_bearer_token", "smithy.api#required": {} } @@ -201,7 +201,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Lists all roles that are assigned to the user for a given AWS account.

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

Lists all roles that are assigned to the user for a given Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/assignment/roles", @@ -211,6 +211,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "roleList", "pageSize": "maxResults" } } @@ -235,7 +236,7 @@ "accessToken": { "target": "com.amazonaws.sso#AccessTokenType", "traits": { - "smithy.api#documentation": "

The token issued by the CreateToken API call. For more information, see\n CreateToken in the AWS SSO OIDC API Reference Guide.

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

The token issued by the CreateToken API call. For more information, see\n CreateToken in the Amazon Web Services SSO OIDC API Reference Guide.

", "smithy.api#httpHeader": "x-amz-sso_bearer_token", "smithy.api#required": {} } @@ -243,7 +244,7 @@ "accountId": { "target": "com.amazonaws.sso#AccountIdType", "traits": { - "smithy.api#documentation": "

The identifier for the AWS account that is assigned to the user.

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

The identifier for the Amazon Web Services account that is assigned to the user.

", "smithy.api#httpQuery": "account_id", "smithy.api#required": {} } @@ -262,7 +263,7 @@ "roleList": { "target": "com.amazonaws.sso#RoleListType", "traits": { - "smithy.api#documentation": "

A paginated response with the list of roles and the next token if more results are available.

" + "smithy.api#documentation": "

A paginated response with the list of roles and the next token if more results are\n available.

" } } } @@ -291,7 +292,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the\n administrator of the account. For more information, see Assign User Access in the AWS SSO User Guide. This operation\n returns a paginated response.

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

Lists all Amazon Web Services accounts assigned to the user. These Amazon Web Services accounts are assigned by the\n administrator of the account. For more information, see Assign User Access in the Amazon Web Services SSO User Guide. This operation\n returns a paginated response.

", "smithy.api#http": { "method": "GET", "uri": "/assignment/accounts", @@ -301,6 +302,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "accountList", "pageSize": "maxResults" } } @@ -311,7 +313,7 @@ "nextToken": { "target": "com.amazonaws.sso#NextTokenType", "traits": { - "smithy.api#documentation": "

(Optional) When requesting subsequent pages, this is the page token from the previous response output.

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

(Optional) When requesting subsequent pages, this is the page token from the previous\n response output.

", "smithy.api#httpQuery": "next_token" } }, @@ -325,7 +327,7 @@ "accessToken": { "target": "com.amazonaws.sso#AccessTokenType", "traits": { - "smithy.api#documentation": "

The token issued by the CreateToken API call. For more information, see\n CreateToken in the AWS SSO OIDC API Reference Guide.

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

The token issued by the CreateToken API call. For more information, see\n CreateToken in the Amazon Web Services SSO OIDC API Reference Guide.

", "smithy.api#httpHeader": "x-amz-sso_bearer_token", "smithy.api#required": {} } @@ -344,7 +346,7 @@ "accountList": { "target": "com.amazonaws.sso#AccountListType", "traits": { - "smithy.api#documentation": "

A paginated response with the list of account information and the next token if more results are available.

" + "smithy.api#documentation": "

A paginated response with the list of account information and the next token if more\n results are available.

" } } } @@ -354,6 +356,9 @@ "input": { "target": "com.amazonaws.sso#LogoutRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sso#InvalidRequestException" @@ -367,7 +372,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Removes the client- and server-side session that is associated with the user.

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

Removes the locally stored SSO tokens from the client-side cache and sends an API call to\n the Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in\n session.

\n\n \n

If a user uses Amazon Web Services SSO to access the AWS CLI, the user’s Amazon Web Services SSO sign in session is\n used to obtain an IAM session, as specified in the corresponding Amazon Web Services SSO permission set.\n More specifically, Amazon Web Services SSO assumes an IAM role in the target account on behalf of the user,\n and the corresponding temporary Amazon Web Services credentials are returned to the client.

\n\n

After user logout, any existing IAM role sessions that were created by using Amazon Web Services SSO\n permission sets continue based on the duration configured in the permission set.\n For more information, see User\n authentications in the Amazon Web Services SSO User\n Guide.

\n ", "smithy.api#http": { "method": "POST", "uri": "/logout", @@ -382,7 +387,7 @@ "accessToken": { "target": "com.amazonaws.sso#AccessTokenType", "traits": { - "smithy.api#documentation": "

The token issued by the CreateToken API call. For more information, see\n CreateToken in the AWS SSO OIDC API Reference Guide.

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

The token issued by the CreateToken API call. For more information, see\n CreateToken in the Amazon Web Services SSO OIDC API Reference Guide.

", "smithy.api#httpHeader": "x-amz-sso_bearer_token", "smithy.api#required": {} } @@ -421,19 +426,19 @@ "accessKeyId": { "target": "com.amazonaws.sso#AccessKeyType", "traits": { - "smithy.api#documentation": "

The identifier used for the temporary security credentials. For more information, see\n Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

" + "smithy.api#documentation": "

The identifier used for the temporary security credentials. For more information, see\n Using Temporary Security Credentials to Request Access to Amazon Web Services Resources in the\n Amazon Web Services IAM User Guide.

" } }, "secretAccessKey": { "target": "com.amazonaws.sso#SecretAccessKeyType", "traits": { - "smithy.api#documentation": "

The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

" + "smithy.api#documentation": "

The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to Amazon Web Services Resources in the\n Amazon Web Services IAM User Guide.

" } }, "sessionToken": { "target": "com.amazonaws.sso#SessionTokenType", "traits": { - "smithy.api#documentation": "

The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

" + "smithy.api#documentation": "

The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to Amazon Web Services Resources in the\n Amazon Web Services IAM User Guide.

" } }, "expiration": { @@ -459,7 +464,7 @@ "accountId": { "target": "com.amazonaws.sso#AccountIdType", "traits": { - "smithy.api#documentation": "

The identifier of the AWS account assigned to the user.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services account assigned to the user.

" } } }, @@ -478,6 +483,21 @@ }, "com.amazonaws.sso#SWBPortalService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SSO", + "arnNamespace": "awsssoportal", + "cloudFormationName": "SSO", + "cloudTrailEventSource": "sso.amazonaws.com", + "endpointPrefix": "portal.sso" + }, + "aws.auth#sigv4": { + "name": "awsssoportal" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Web Services Single Sign On Portal is a web service that makes it easy for you to assign user access to\n Amazon Web Services SSO resources such as the AWS access portal. Users can get Amazon Web Services account applications and roles\n assigned to them and get federated into the application.

\n\n \n

Although Amazon Web Services 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 Amazon Web Services SSO rename.

\n \n\n

This reference guide describes the Amazon Web Services SSO Portal operations that you can call\n programatically and includes detailed information on data types and errors.

\n\n \n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a\n convenient way to create programmatic access to Amazon Web Services SSO and other Amazon Web Services services. For more\n information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

\n ", + "smithy.api#title": "AWS Single Sign-On" + }, "version": "2019-06-10", "operations": [ { @@ -492,22 +512,7 @@ { "target": "com.amazonaws.sso#Logout" } - ], - "traits": { - "aws.api#service": { - "sdkId": "SSO", - "arnNamespace": "awsssoportal", - "cloudFormationName": "SSO", - "cloudTrailEventSource": "sso.amazonaws.com", - "endpointPrefix": "portal.sso" - }, - "aws.auth#sigv4": { - "name": "awsssoportal" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Single Sign-On Portal is a web service that makes it easy for you to assign user\n access to AWS SSO resources such as the user portal. Users can get AWS account applications\n and roles assigned to them and get federated into the application.

\n \n

For general information about AWS SSO, see What is AWS\n Single Sign-On? in the AWS SSO User Guide.

\n \n

This API reference guide describes the AWS SSO Portal operations that you can call\n programatically and includes detailed information on data types and errors.

\n \n \n

AWS provides SDKs that consist of libraries and sample code for various programming\n languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a\n convenient way to create programmatic access to AWS SSO and other AWS services. For more\n information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

\n ", - "smithy.api#title": "AWS Single Sign-On" - } + ] }, "com.amazonaws.sso#SecretAccessKeyType": { "type": "string", @@ -529,7 +534,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates that the request is being made too frequently and is more than what the server can handle.

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

Indicates that the request is being made too frequently and is more than what the server\n can handle.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -542,7 +547,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

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

Indicates that the request is not authorized. This can happen due to an invalid access\n token in the request.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } diff --git a/codegen/sdk/aws-models/wisdom.json b/codegen/sdk/aws-models/wisdom.json index 9e1e171fc65..761d503b834 100644 --- a/codegen/sdk/aws-models/wisdom.json +++ b/codegen/sdk/aws-models/wisdom.json @@ -68,6 +68,9 @@ { "target": "com.amazonaws.wisdom#NotifyRecommendationsReceived" }, + { + "target": "com.amazonaws.wisdom#PutFeedback" + }, { "target": "com.amazonaws.wisdom#QueryAssistant" }, @@ -1535,6 +1538,21 @@ "smithy.api#documentation": "

The text of the document.

" } }, + "com.amazonaws.wisdom#FeedbackData": { + "type": "structure", + "members": { + "relevance": { + "target": "com.amazonaws.wisdom#Relevance", + "traits": { + "smithy.api#documentation": "

The relevance of the target this feedback is for.

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

The feedback to submit to Wisdom.

" + } + }, "com.amazonaws.wisdom#Filter": { "type": "structure", "members": { @@ -2851,6 +2869,109 @@ "smithy.api#httpError": 412 } }, + "com.amazonaws.wisdom#PutFeedback": { + "type": "operation", + "input": { + "target": "com.amazonaws.wisdom#PutFeedbackRequest" + }, + "output": { + "target": "com.amazonaws.wisdom#PutFeedbackResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wisdom#AccessDeniedException" + }, + { + "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Submits feedback to Wisdom. The feedback is used to improve future recommendations from\n GetRecommendations or\n results from QueryAssistant.\n Feedback can be resubmitted up to 6 hours after submission.\n

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/feedback", + "method": "PUT" + }, + "smithy.api#idempotent": {}, + "smithy.api#private": {} + } + }, + "com.amazonaws.wisdom#PutFeedbackRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of a recommendation. or The identifier of the result data.

", + "smithy.api#required": {} + } + }, + "targetType": { + "target": "com.amazonaws.wisdom#TargetType", + "traits": { + "smithy.api#documentation": "

The type of the targetId for which The feedback. is targeted.

", + "smithy.api#required": {} + } + }, + "feedback": { + "target": "com.amazonaws.wisdom#FeedbackData", + "traits": { + "smithy.api#documentation": "

The feedback.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wisdom#PutFeedbackResponse": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Wisdom assistant.

", + "smithy.api#required": {} + } + }, + "assistantArn": { + "target": "com.amazonaws.wisdom#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant.

", + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of a recommendation. or The identifier of the result data.

", + "smithy.api#required": {} + } + }, + "targetType": { + "target": "com.amazonaws.wisdom#TargetType", + "traits": { + "smithy.api#documentation": "

The type of the targetId for which The feedback. is targeted.

", + "smithy.api#required": {} + } + }, + "feedback": { + "target": "com.amazonaws.wisdom#FeedbackData", + "traits": { + "smithy.api#documentation": "

The feedback.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.wisdom#QueryAssistant": { "type": "operation", "input": { @@ -3120,6 +3241,21 @@ ] } }, + "com.amazonaws.wisdom#Relevance": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HELPFUL", + "name": "HELPFUL" + }, + { + "value": "NOT_HELPFUL", + "name": "NOT_HELPFUL" + } + ] + } + }, "com.amazonaws.wisdom#RelevanceLevel": { "type": "string", "traits": { @@ -3763,6 +3899,21 @@ "target": "com.amazonaws.wisdom#TagValue" } }, + "com.amazonaws.wisdom#TargetType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RECOMMENDATION", + "name": "RECOMMENDATION" + }, + { + "value": "RESULT", + "name": "RESULT" + } + ] + } + }, "com.amazonaws.wisdom#TooManyTagsException": { "type": "structure", "members": { From 330d278d904b9f7c04910772b96fbd252a4f5499 Mon Sep 17 00:00:00 2001 From: Ian Smith Botsford Date: Thu, 18 Aug 2022 21:41:26 +0000 Subject: [PATCH 2/3] empty commit to refresh CI From c2c5767f61c4b57a1d2df9ed5a5b2798bcc9bce1 Mon Sep 17 00:00:00 2001 From: Ian Smith Botsford Date: Thu, 18 Aug 2022 22:08:16 +0000 Subject: [PATCH 3/3] and also bump smithy-kotlin version --- .changes/93d2e317-4264-460f-a9f5-a578db34178a.json | 5 +++++ gradle.properties | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 .changes/93d2e317-4264-460f-a9f5-a578db34178a.json diff --git a/.changes/93d2e317-4264-460f-a9f5-a578db34178a.json b/.changes/93d2e317-4264-460f-a9f5-a578db34178a.json new file mode 100644 index 00000000000..5ce81291f78 --- /dev/null +++ b/.changes/93d2e317-4264-460f-a9f5-a578db34178a.json @@ -0,0 +1,5 @@ +{ + "id": "93d2e317-4264-460f-a9f5-a578db34178a", + "type": "misc", + "description": "Upgrade smithy-kotlin to latest released version, 0.12.5" +} diff --git a/gradle.properties b/gradle.properties index c61a41882f2..255b46396b5 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,7 +12,7 @@ sdkVersion=0.17.5-SNAPSHOT smithyVersion=1.23.0 smithyGradleVersion=0.6.0 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.12.5-SNAPSHOT +smithyKotlinVersion=0.12.5 # kotlin kotlinVersion=1.7.10