From d9c18aa2bdd4c237a4919452f58e29c20ba484cc Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Thu, 1 Dec 2022 19:03:35 +0000 Subject: [PATCH] Update API model --- .../sdk-codegen/aws-models/codecatalyst.json | 5519 ++++++++++ .../sdk-codegen/aws-models/comprehend.json | 3874 +++++-- codegen/sdk-codegen/aws-models/gamelift.json | 8994 +++++++++++------ codegen/sdk-codegen/aws-models/pipes.json | 5098 ++++++++++ codegen/sdk-codegen/aws-models/sfn.json | 729 +- 5 files changed, 20362 insertions(+), 3852 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/codecatalyst.json create mode 100644 codegen/sdk-codegen/aws-models/pipes.json diff --git a/codegen/sdk-codegen/aws-models/codecatalyst.json b/codegen/sdk-codegen/aws-models/codecatalyst.json new file mode 100644 index 00000000000..515bd2b4006 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/codecatalyst.json @@ -0,0 +1,5519 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.codecatalyst#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.codecatalyst#AccessToken": { + "type": "resource", + "identifiers": { + "accessTokenId": { + "target": "com.amazonaws.codecatalyst#AccessTokenId" + } + }, + "create": { + "target": "com.amazonaws.codecatalyst#CreateAccessToken" + }, + "delete": { + "target": "com.amazonaws.codecatalyst#DeleteAccessToken" + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListAccessTokens" + } + }, + "com.amazonaws.codecatalyst#AccessTokenId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.codecatalyst#AccessTokenName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.codecatalyst#AccessTokenSecret": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.codecatalyst#AccessTokenSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#AccessTokenSummary" + } + }, + "com.amazonaws.codecatalyst#AccessTokenSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codecatalyst#AccessTokenId", + "traits": { + "smithy.api#documentation": "

The system-generated ID of the personal access token.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "accessTokenId" + } + }, + "name": { + "target": "com.amazonaws.codecatalyst#AccessTokenName", + "traits": { + "smithy.api#documentation": "

The friendly name of the personal access token.

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

The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

Information about a specified personal access token (PAT).

" + } + }, + "com.amazonaws.codecatalyst#Action": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "actionId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#ActionLogResource": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "actionLogId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#ActionRun": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "workflowRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "actionRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#ActionRunArtifactMetadata" + }, + { + "target": "com.amazonaws.codecatalyst#ActionRunLogEntries" + } + ] + }, + "com.amazonaws.codecatalyst#ActionRunArtifactMetadata": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "workflowRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "actionRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "artifactName": { + "target": "com.amazonaws.codecatalyst#ArtifactNameString" + } + } + }, + "com.amazonaws.codecatalyst#ActionRunLogEntries": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "workflowRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "actionRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#ActionRunLogsDownloadableUrl": { + "type": "resource", + "identifiers": { + "actionRunId": { + "target": "smithy.api#String" + }, + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#ActionVersion": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "actionId": { + "target": "smithy.api#String" + }, + "versionId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#ArtifactNameString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.codecatalyst#ArtifactPackage": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "artifactRepositoryName": { + "target": "com.amazonaws.codecatalyst#ArtifactRepositoryNameString" + } + } + }, + "com.amazonaws.codecatalyst#ArtifactPackageVersion": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "artifactRepositoryName": { + "target": "com.amazonaws.codecatalyst#ArtifactRepositoryNameString" + } + } + }, + "com.amazonaws.codecatalyst#ArtifactRepository": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "artifactRepositoryName": { + "target": "com.amazonaws.codecatalyst#ArtifactRepositoryNameString" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#ArtifactPackage" + }, + { + "target": "com.amazonaws.codecatalyst#ArtifactPackageVersion" + } + ] + }, + "com.amazonaws.codecatalyst#ArtifactRepositoryNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-_.]{1,99}$" + } + }, + "com.amazonaws.codecatalyst#AwsAccountOnboardingResource": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "awsAccountName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#AwsAccountResource": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "awsAccountName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#AwsAccountRoleResource" + } + ] + }, + "com.amazonaws.codecatalyst#AwsAccountRoleResource": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "awsAccountName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "roleName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#AwsAccountToEnvironmentAssociation": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "awsAccountName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "environmentName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#Bar": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "barName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#BillingAccountChangeStatus": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#Blueprint": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#BuildLogsMigration": { + "type": "resource", + "identifiers": { + "buildId": { + "target": "smithy.api#String" + }, + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#CatalogAction": { + "type": "resource", + "identifiers": { + "catalogActionId": { + "target": "smithy.api#String" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#CatalogActionVersion" + } + ] + }, + "com.amazonaws.codecatalyst#CatalogActionVersion": { + "type": "resource", + "identifiers": { + "catalogActionId": { + "target": "smithy.api#String" + }, + "versionId": { + "target": "smithy.api#String" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#CatalogActionVersionFileRecord" + } + ] + }, + "com.amazonaws.codecatalyst#CatalogActionVersionFileRecord": { + "type": "resource", + "identifiers": { + "catalogActionId": { + "target": "smithy.api#String" + }, + "versionId": { + "target": "smithy.api#String" + }, + "fileType": { + "target": "com.amazonaws.codecatalyst#CatalogActionVersionFileRecordType" + } + } + }, + "com.amazonaws.codecatalyst#CatalogActionVersionFileRecordType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LICENSE", + "value": "LICENSE" + }, + { + "name": "README", + "value": "README" + } + ] + } + }, + "com.amazonaws.codecatalyst#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.codecatalyst#CodeCatalyst": { + "type": "service", + "version": "2022-09-28", + "operations": [ + { + "target": "com.amazonaws.codecatalyst#GetUserDetails" + }, + { + "target": "com.amazonaws.codecatalyst#VerifySession" + } + ], + "resources": [ + { + "target": "com.amazonaws.codecatalyst#AccessToken" + }, + { + "target": "com.amazonaws.codecatalyst#ActionRunLogsDownloadableUrl" + }, + { + "target": "com.amazonaws.codecatalyst#BuildLogsMigration" + }, + { + "target": "com.amazonaws.codecatalyst#CatalogAction" + }, + { + "target": "com.amazonaws.codecatalyst#CommentForIssue" + }, + { + "target": "com.amazonaws.codecatalyst#LinkableIssueScope" + }, + { + "target": "com.amazonaws.codecatalyst#Organization" + }, + { + "target": "com.amazonaws.codecatalyst#Person" + }, + { + "target": "com.amazonaws.codecatalyst#ProjectInvitations" + }, + { + "target": "com.amazonaws.codecatalyst#PullRequestComment" + }, + { + "target": "com.amazonaws.codecatalyst#RoleMappingAssociations" + }, + { + "target": "com.amazonaws.codecatalyst#RoleMappingAssociationsMigration" + }, + { + "target": "com.amazonaws.codecatalyst#Space" + }, + { + "target": "com.amazonaws.codecatalyst#SSHPublicKey" + } + ], + "errors": [ + { + "target": "com.amazonaws.codecatalyst#AccessDeniedException" + }, + { + "target": "com.amazonaws.codecatalyst#ConflictException" + }, + { + "target": "com.amazonaws.codecatalyst#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codecatalyst#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.codecatalyst#ThrottlingException" + }, + { + "target": "com.amazonaws.codecatalyst#ValidationException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CodeCatalyst", + "endpointPrefix": "codecatalyst" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "\n

\n Amazon CodeCatalyst is in preview release and subject to change.\n

\n \n

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst \n API to work with the following objects.

\n

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

\n \n

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

\n ", + "smithy.api#httpBearerAuth": {}, + "smithy.api#title": "Amazon CodeCatalyst", + "smithy.rules#endpointRuleSet": { + "version": "1.3", + "parameters": { + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + "us-west-2" + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + false + ] + } + ], + "error": "Partition does not support FIPS.", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://codecatalyst-fips.global.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://codecatalyst.global.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + false + ] + } + ], + "error": "Partition does not support FIPS.", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://codecatalyst-fips.global.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://codecatalyst.global.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "Override endpoint", + "expect": { + "endpoint": { + "url": "https://test.codecatalyst.global.api.aws" + } + }, + "params": { + "Endpoint": "https://test.codecatalyst.global.api.aws" + } + }, + { + "documentation": "Default endpoint (region not set)", + "expect": { + "endpoint": { + "url": "https://codecatalyst.global.api.aws" + } + } + }, + { + "documentation": "Default FIPS endpoint (region not set)", + "expect": { + "endpoint": { + "url": "https://codecatalyst-fips.global.api.aws" + } + }, + "params": { + "UseFIPS": true + } + }, + { + "documentation": "Default endpoint (region: aws-global)", + "expect": { + "endpoint": { + "url": "https://codecatalyst.global.api.aws" + } + }, + "params": { + "Region": "aws-global" + } + }, + { + "documentation": "Default FIPS endpoint (region: aws-global)", + "expect": { + "endpoint": { + "url": "https://codecatalyst-fips.global.api.aws" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": true + } + }, + { + "documentation": "Default endpoint for a valid home region (region: us-west-2)", + "expect": { + "endpoint": { + "url": "https://codecatalyst.global.api.aws" + } + }, + "params": { + "Region": "us-west-2" + } + }, + { + "documentation": "Default FIPS endpoint for a valid home region (region: us-west-2)", + "expect": { + "endpoint": { + "url": "https://codecatalyst-fips.global.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "Default endpoint for an unavailable home region (region: us-east-1)", + "expect": { + "endpoint": { + "url": "https://codecatalyst.global.api.aws" + } + }, + "params": { + "Region": "us-east-1" + } + }, + { + "documentation": "Default FIPS endpoint for an unavailable home region (region: us-east-1)", + "expect": { + "endpoint": { + "url": "https://codecatalyst-fips.global.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.codecatalyst#CodeCoverageReport": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "codeCoverageReportId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#CodeCoverageResult": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "codeCoverageResultId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#CommentForIssue": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueId": { + "target": "smithy.api#String" + }, + "commentId": { + "target": "smithy.api#String" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#IssueCommentReaction" + } + ] + }, + "com.amazonaws.codecatalyst#ComparisonOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "EQUALS", + "value": "EQ" + }, + { + "name": "GREATER_THAN", + "value": "GT" + }, + { + "name": "GREATER_THAN_OR_EQUALS", + "value": "GE" + }, + { + "name": "LESS_THAN", + "value": "LT" + }, + { + "name": "LESS_THAN_OR_EQUALS", + "value": "LE" + } + ] + } + }, + "com.amazonaws.codecatalyst#ComputeFleet": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "computeFleetName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#ComputeFleetMigration": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "computeFleetName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. \n Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.codecatalyst#Connection": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "providerId": { + "target": "com.amazonaws.codecatalyst#ProviderIdString" + }, + "connectionName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#CreateAccessToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#CreateAccessTokenRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#CreateAccessTokenResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. \n It is associated with your user account. You use PATs to access Amazon CodeCatalyst resources such as source repositories from third-party applications \n like Git and integrated development environments (IDEs). For more information, see \n Managing personal access tokens in Amazon CodeCatalyst.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/accessTokens", + "code": 201 + } + } + }, + "com.amazonaws.codecatalyst#CreateAccessTokenRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codecatalyst#AccessTokenName", + "traits": { + "smithy.api#documentation": "

The friendly name of the personal access token.

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

The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

", + "smithy.api#timestampFormat": "date-time" + } + } + } + }, + "com.amazonaws.codecatalyst#CreateAccessTokenResponse": { + "type": "structure", + "members": { + "secret": { + "target": "com.amazonaws.codecatalyst#AccessTokenSecret", + "traits": { + "smithy.api#documentation": "

The secret value of the personal access token.

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

The friendly name of the personal access token.

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

The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339. If not specified, the default is one year from creation.

", + "smithy.api#timestampFormat": "date-time" + } + } + } + }, + "com.amazonaws.codecatalyst#CreateDevEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#CreateDevEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#CreateDevEnvironmentResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development Dev Environment that you can use to quickly work on the code stored in the source repositories of your project. \n By default, a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#CreateDevEnvironmentRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "repositories": { + "target": "com.amazonaws.codecatalyst#RepositoriesInput", + "traits": { + "smithy.api#documentation": "

The source repository that contains the branch to clone into the Dev Environment.

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

A user-specified idempotency token. Idempotency ensures that an API request completes only once. \n With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

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

The user-defined alias for a Dev Environment.

", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*$" + } + }, + "ides": { + "target": "com.amazonaws.codecatalyst#IdeConfigurationList", + "traits": { + "smithy.api#documentation": "

Information about the integrated development environment (IDE) configured for a\n Dev Environment.

\n \n

An IDE is required to create a Dev Environment. For Dev Environment creation, this field\n contains configuration information and must be provided.

\n " + } + }, + "instanceType": { + "target": "com.amazonaws.codecatalyst#InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instace type to use for the Dev Environment.

", + "smithy.api#required": {} + } + }, + "inactivityTimeoutMinutes": { + "target": "com.amazonaws.codecatalyst#InactivityTimeoutMinutes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

" + } + }, + "persistentStorage": { + "target": "com.amazonaws.codecatalyst#PersistentStorageConfiguration", + "traits": { + "smithy.api#documentation": "

Information about the amount of storage allocated to the Dev Environment. By default, a\n Dev Environment is configured to have 16GB of persistent storage.

\n \n

Valid values for persistent storage are based on memory sizes in 16GB increments. Valid\n values are 16, 32, and 64.

\n ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#CreateDevEnvironmentResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + } + } + }, + "com.amazonaws.codecatalyst#CreateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#CreateProjectRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#CreateProjectResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates a project in a specified space.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/spaces/{spaceName}/projects", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#CreateProjectRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.codecatalyst#ProjectDisplayName", + "traits": { + "smithy.api#documentation": "

The friendly name of the project that will be displayed to users.

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

The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.

" + } + } + } + }, + "com.amazonaws.codecatalyst#CreateProjectResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

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

The name of the project in the space.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "projectName" + } + }, + "displayName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The friendly name of the project.

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

The description of the project.

" + } + } + } + }, + "com.amazonaws.codecatalyst#CreateSourceRepositoryBranch": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#CreateSourceRepositoryBranchRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#CreateSourceRepositoryBranchResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates a branch in a specified source repository in Amazon CodeCatalyst.

\n \n

This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/branches/{name}", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#CreateSourceRepositoryBranchRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString", + "traits": { + "smithy.api#documentation": "

The name of the repository where you want to create a branch.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString", + "traits": { + "smithy.api#documentation": "

The name for the branch you're creating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "sourceRepositoryBranchName" + } + }, + "headCommitId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The commit ID in an existing branch from which you want to create the new branch.

" + } + } + } + }, + "com.amazonaws.codecatalyst#CreateSourceRepositoryBranchResponse": { + "type": "structure", + "members": { + "ref": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchRefString", + "traits": { + "smithy.api#documentation": "

The Git reference name of the branch.

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

The name of the newly created branch.

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

The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

The commit ID of the tip of the newly created branch.

" + } + } + } + }, + "com.amazonaws.codecatalyst#DeleteAccessToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#DeleteAccessTokenRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#DeleteAccessTokenResponse" + }, + "traits": { + "smithy.api#documentation": "

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/accessTokens/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#DeleteAccessTokenRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codecatalyst#AccessTokenId", + "traits": { + "smithy.api#documentation": "

The ID of the personal access token to delete. You can find the IDs of all PATs associated with your user account by calling ListAccessTokens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "accessTokenId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codecatalyst#DeleteAccessTokenResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codecatalyst#DeleteDevEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#DeleteDevEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#DeleteDevEnvironmentResponse" + }, + "traits": { + "smithy.api#documentation": "

Deletes a Dev Environment.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#DeleteDevEnvironmentRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment you want to delete. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + } + } + }, + "com.amazonaws.codecatalyst#DeleteDevEnvironmentResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the deleted Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + } + } + }, + "com.amazonaws.codecatalyst#DevEnvironment": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "devEnvironmentId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + }, + "create": { + "target": "com.amazonaws.codecatalyst#CreateDevEnvironment" + }, + "read": { + "target": "com.amazonaws.codecatalyst#GetDevEnvironment" + }, + "update": { + "target": "com.amazonaws.codecatalyst#UpdateDevEnvironment" + }, + "delete": { + "target": "com.amazonaws.codecatalyst#DeleteDevEnvironment" + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListDevEnvironments" + }, + "operations": [ + { + "target": "com.amazonaws.codecatalyst#StartDevEnvironment" + }, + { + "target": "com.amazonaws.codecatalyst#StartDevEnvironmentSession" + }, + { + "target": "com.amazonaws.codecatalyst#StopDevEnvironment" + } + ] + }, + "com.amazonaws.codecatalyst#DevEnvironmentAccessDetails": { + "type": "structure", + "members": { + "streamUrl": { + "target": "com.amazonaws.codecatalyst#SensitiveString", + "traits": { + "smithy.api#documentation": "

The URL used to send commands to and from the Dev Environment.

", + "smithy.api#required": {} + } + }, + "tokenValue": { + "target": "com.amazonaws.codecatalyst#SensitiveString", + "traits": { + "smithy.api#documentation": "

An encrypted token value that contains session and caller information used to authenticate the connection.

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

Information about connection details for a Dev Environment.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.codecatalyst#DevEnvironmentRepositorySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentRepositorySummary" + } + }, + "com.amazonaws.codecatalyst#DevEnvironmentRepositorySummary": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString", + "traits": { + "smithy.api#documentation": "

The name of the source repository.

", + "smithy.api#required": {} + } + }, + "branchName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString", + "traits": { + "smithy.api#documentation": "

The name of the branch in a source repository cloned into the Dev Environment.

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

Information about the source repsitory for a Dev Environment.

" + } + }, + "com.amazonaws.codecatalyst#DevEnvironmentSessionConfiguration": { + "type": "structure", + "members": { + "sessionType": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentSessionType", + "traits": { + "smithy.api#documentation": "

The type of the session.

", + "smithy.api#required": {} + } + }, + "executeCommandSessionConfiguration": { + "target": "com.amazonaws.codecatalyst#ExecuteCommandSessionConfiguration", + "traits": { + "smithy.api#documentation": "

Information about optional commands that will be run on the Dev Environment when the SSH session begins.

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

Information about the configuration of a Dev Environment session.

" + } + }, + "com.amazonaws.codecatalyst#DevEnvironmentSessionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SSM", + "value": "SSM" + }, + { + "name": "SSH", + "value": "SSH" + } + ] + } + }, + "com.amazonaws.codecatalyst#DevEnvironmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "PENDING", + "value": "PENDING" + }, + { + "name": "RUNNING", + "value": "RUNNING" + }, + { + "name": "STARTING", + "value": "STARTING" + }, + { + "name": "STOPPING", + "value": "STOPPING" + }, + { + "name": "STOPPED", + "value": "STOPPED" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "DELETING", + "value": "DELETING" + }, + { + "name": "DELETED", + "value": "DELETED" + } + ] + } + }, + "com.amazonaws.codecatalyst#DevEnvironmentSummary": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

" + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

" + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID for the Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

The system-generated unique ID of the user who created the Dev Environment.

", + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the Dev Environment.

", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "com.amazonaws.codecatalyst#StatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the status.

" + } + }, + "repositories": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentRepositorySummaries", + "traits": { + "smithy.api#documentation": "

Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.

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

The user-specified alias for the Dev Environment.

", + "smithy.api#length": { + "max": 128 + } + } + }, + "ides": { + "target": "com.amazonaws.codecatalyst#Ides", + "traits": { + "smithy.api#documentation": "

Information about the integrated development environment (IDE) configured for a Dev Environment.

" + } + }, + "instanceType": { + "target": "com.amazonaws.codecatalyst#InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instace type used for the Dev Environment.

", + "smithy.api#required": {} + } + }, + "inactivityTimeoutMinutes": { + "target": "com.amazonaws.codecatalyst#InactivityTimeoutMinutes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.

", + "smithy.api#required": {} + } + }, + "persistentStorage": { + "target": "com.amazonaws.codecatalyst#PersistentStorage", + "traits": { + "smithy.api#documentation": "

Information about the configuration of persistent storage for the Dev Environment.

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

Information about a Dev Environment.

" + } + }, + "com.amazonaws.codecatalyst#DevEnvironmentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentSummary" + } + }, + "com.amazonaws.codecatalyst#DummyData": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "dummyDataName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#EmailAddress": { + "type": "structure", + "members": { + "email": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The email address.

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

Whether the email address has been verified.

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

Information about an email address.

" + } + }, + "com.amazonaws.codecatalyst#Environment": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "environmentName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#EnvironmentDeployment" + }, + { + "target": "com.amazonaws.codecatalyst#EnvironmentDeploymentTarget" + }, + { + "target": "com.amazonaws.codecatalyst#EnvironmentResourceMetadata" + } + ] + }, + "com.amazonaws.codecatalyst#EnvironmentDeployment": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "environmentName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "deploymentId": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#EnvironmentDeploymentTarget": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "environmentName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "targetId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#EnvironmentResourceMetadata": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "environmentName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#EventLogEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#EventLogEntry" + } + }, + "com.amazonaws.codecatalyst#EventLogEntry": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the event.

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

The name of the event.

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

The type of the event.

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

The category for the event.

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

The source of the event.

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

The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "operationType": { + "target": "com.amazonaws.codecatalyst#OperationType", + "traits": { + "smithy.api#documentation": "

The type of the event.

", + "smithy.api#required": {} + } + }, + "userIdentity": { + "target": "com.amazonaws.codecatalyst#UserIdentity", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the user whose actions are recorded in the event.

", + "smithy.api#required": {} + } + }, + "projectInformation": { + "target": "com.amazonaws.codecatalyst#ProjectInformation", + "traits": { + "smithy.api#documentation": "

Information about the project where the event occurred.

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

The system-generated unique ID of the request.

" + } + }, + "requestPayload": { + "target": "com.amazonaws.codecatalyst#EventPayload", + "traits": { + "smithy.api#documentation": "

Information about the payload of the request.

" + } + }, + "responsePayload": { + "target": "com.amazonaws.codecatalyst#EventPayload", + "traits": { + "smithy.api#documentation": "

Information about the payload of the response, if any.

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

The code of the error, if any.

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

The IP address of the user whose actions are recorded in the event.

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

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

Information about an entry in an event log of Amazon CodeCatalyst activity.

" + } + }, + "com.amazonaws.codecatalyst#EventLogResource": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "eventLogId": { + "target": "smithy.api#String" + } + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListEventLogs" + } + }, + "com.amazonaws.codecatalyst#EventPayload": { + "type": "structure", + "members": { + "contentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of content in the event payload.

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

The data included in the event payload.

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

Information about the payload of an event recording Amazon CodeCatalyst activity.

" + } + }, + "com.amazonaws.codecatalyst#ExecuteCommandSessionConfiguration": { + "type": "structure", + "members": { + "command": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The command used at the beginning of the SSH session to a Dev Environment.

", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#required": {} + } + }, + "arguments": { + "target": "com.amazonaws.codecatalyst#ExecuteCommandSessionConfigurationArguments", + "traits": { + "smithy.api#documentation": "

An array of arguments containing arguments and members.

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

Information about the commands that will be run on a Dev Environment when an SSH session begins.

" + } + }, + "com.amazonaws.codecatalyst#ExecuteCommandSessionConfigurationArguments": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + } + }, + "com.amazonaws.codecatalyst#ExtensionIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9a-zA-z\\-]+$" + } + }, + "com.amazonaws.codecatalyst#ExtensionInstallation": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "extensionId": { + "target": "com.amazonaws.codecatalyst#ExtensionIdString" + } + } + }, + "com.amazonaws.codecatalyst#ExtensionIssue": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#ExtensionIssueScope": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "extensionIssueScopeName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#ExternalArtifactRepository": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "artifactRepositoryName": { + "target": "com.amazonaws.codecatalyst#ArtifactRepositoryNameString" + } + } + }, + "com.amazonaws.codecatalyst#Filter": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.codecatalyst#StringList", + "traits": { + "smithy.api#documentation": "

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

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

" + } + }, + "com.amazonaws.codecatalyst#FilterKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "HAS_ACCESS_TO", + "value": "hasAccessTo" + } + ] + } + }, + "com.amazonaws.codecatalyst#Filters": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#Filter" + } + }, + "com.amazonaws.codecatalyst#GetDevEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetDevEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetDevEnvironmentResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetDevEnvironmentRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + } + } + }, + "com.amazonaws.codecatalyst#GetDevEnvironmentResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

The system-generated unique ID of the user who created the Dev Environment.

", + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentStatus", + "traits": { + "smithy.api#documentation": "

The current status of the Dev Environment.

", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "com.amazonaws.codecatalyst#StatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the status.

" + } + }, + "repositories": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentRepositorySummaries", + "traits": { + "smithy.api#documentation": "

The source repository that contains the branch cloned into the Dev Environment.

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

The user-specified alias for the Dev Environment.

", + "smithy.api#length": { + "max": 128 + } + } + }, + "ides": { + "target": "com.amazonaws.codecatalyst#Ides", + "traits": { + "smithy.api#documentation": "

Information about the integrated development environment (IDE) configured for the Dev Environment.

" + } + }, + "instanceType": { + "target": "com.amazonaws.codecatalyst#InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instace type to use for the Dev Environment.

", + "smithy.api#required": {} + } + }, + "inactivityTimeoutMinutes": { + "target": "com.amazonaws.codecatalyst#InactivityTimeoutMinutes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

", + "smithy.api#required": {} + } + }, + "persistentStorage": { + "target": "com.amazonaws.codecatalyst#PersistentStorage", + "traits": { + "smithy.api#documentation": "

Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#GetProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetProjectRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetProjectResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about a project.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/spaces/{spaceName}/projects/{name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetProjectRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "projectName" + } + } + } + }, + "com.amazonaws.codecatalyst#GetProjectResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

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

The name of the project in the space.

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

The friendly name of the project displayed to users in Amazon CodeCatalyst.

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

The description of the project.

" + } + } + } + }, + "com.amazonaws.codecatalyst#GetSourceRepositoryCloneUrls": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetSourceRepositoryCloneUrlsRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetSourceRepositoryCloneUrlsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about the URLs that can be used with a Git client to clone a source\n repository.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/cloneUrls", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetSourceRepositoryCloneUrlsRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString", + "traits": { + "smithy.api#documentation": "

The name of the source repository.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#GetSourceRepositoryCloneUrlsResponse": { + "type": "structure", + "members": { + "https": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTPS URL to use when cloning the source repository.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#GetSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetSpaceRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetSpaceResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about an space.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/spaces/{name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetSpaceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "spaceName" + } + } + } + }, + "com.amazonaws.codecatalyst#GetSpaceResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "regionName": { + "target": "com.amazonaws.codecatalyst#RegionString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where the space exists.

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

The friendly name of the space displayed to users.

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

The description of the space.

" + } + } + } + }, + "com.amazonaws.codecatalyst#GetSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetSubscriptionResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about the Amazon Web Services account used for billing purposes \n and the billing plan for the space.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/spaces/{spaceName}/subscription", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetSubscriptionRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#GetSubscriptionResponse": { + "type": "structure", + "members": { + "subscriptionType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of the billing plan for the space.

" + } + }, + "awsAccountName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The display name of the Amazon Web Services account used for billing for the space.

" + } + } + } + }, + "com.amazonaws.codecatalyst#GetUserDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetUserDetailsRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetUserDetailsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about a user.

", + "smithy.api#http": { + "method": "GET", + "uri": "/userDetails", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetUserDetailsRequest": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the user.

", + "smithy.api#httpQuery": "id", + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "userName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the user as displayed in Amazon CodeCatalyst.

", + "smithy.api#httpQuery": "userName", + "smithy.api#length": { + "min": 3, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{3,100}$" + } + } + } + }, + "com.amazonaws.codecatalyst#GetUserDetailsResponse": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the user.

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

The name of the user as displayed in Amazon CodeCatalyst.

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

The friendly name displayed for the user in Amazon CodeCatalyst.

" + } + }, + "primaryEmail": { + "target": "com.amazonaws.codecatalyst#EmailAddress", + "traits": { + "smithy.api#documentation": "

The email address provided by the user when they signed up.

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

" + } + } + } + }, + "com.amazonaws.codecatalyst#Ide": { + "type": "structure", + "members": { + "runtime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A link to the IDE runtime image.

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

The name of the IDE.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an integrated development environment (IDE) used in a Dev Environment.

" + } + }, + "com.amazonaws.codecatalyst#IdeConfiguration": { + "type": "structure", + "members": { + "runtime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A link to the IDE runtime image.

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

The name of the IDE.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the configuration of an integrated development environment (IDE) for a Dev Environment.

" + } + }, + "com.amazonaws.codecatalyst#IdeConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#IdeConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.codecatalyst#Ides": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#Ide" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.codecatalyst#InactivityTimeoutMinutes": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1200 + } + } + }, + "com.amazonaws.codecatalyst#Incident": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "incidentId": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#InstanceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DEV_STANDARD1_SMALL", + "value": "dev.standard1.small" + }, + { + "name": "DEV_STANDARD1_MEDIUM", + "value": "dev.standard1.medium" + }, + { + "name": "DEV_STANDARD1_LARGE", + "value": "dev.standard1.large" + }, + { + "name": "DEV_STANDARD1_XLARGE", + "value": "dev.standard1.xlarge" + } + ] + } + }, + "com.amazonaws.codecatalyst#Issue": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueId": { + "target": "com.amazonaws.codecatalyst#IssueId" + } + } + }, + "com.amazonaws.codecatalyst#IssueCommentReaction": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueId": { + "target": "smithy.api#String" + }, + "commentId": { + "target": "smithy.api#String" + }, + "reactionId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#IssueId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.codecatalyst#IssueMigration": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreName": { + "target": "com.amazonaws.codecatalyst#IssueStoreNameString" + }, + "issueId": { + "target": "com.amazonaws.codecatalyst#IssueId" + } + } + }, + "com.amazonaws.codecatalyst#IssueStore": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#Issue" + }, + { + "target": "com.amazonaws.codecatalyst#IssueStoreLabel" + }, + { + "target": "com.amazonaws.codecatalyst#IssueStoreSavedView" + }, + { + "target": "com.amazonaws.codecatalyst#IssueStoreStatusResource" + } + ] + }, + "com.amazonaws.codecatalyst#IssueStoreLabel": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreLabelId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#IssueStoreMigration": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreName": { + "target": "com.amazonaws.codecatalyst#IssueStoreNameString" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#IssueMigration" + } + ] + }, + "com.amazonaws.codecatalyst#IssueStoreNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.codecatalyst#IssueStoreSavedView": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#IssueStoreStatusResource": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "issueStoreStatusId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#Link": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "linkId": { + "target": "com.amazonaws.codecatalyst#LinkId" + } + } + }, + "com.amazonaws.codecatalyst#LinkId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}_[0-9a-zA-Z_]{4,62}_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.codecatalyst#LinkableIssueScope": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "connectionName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "extensionIssueScopeName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#LinkableSourceRepository": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "connectionName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + } + } + }, + "com.amazonaws.codecatalyst#ListAccessTokens": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListAccessTokensRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListAccessTokensResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your user account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/accessTokens", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListAccessTokensRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

", + "smithy.api#range": { + "max": 10 + } + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codecatalyst#ListAccessTokensResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.codecatalyst#AccessTokenSummaries", + "traits": { + "smithy.api#documentation": "

A list of personal access tokens (PATs) associated with the calling user.

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

A token returned from a call to this API to indicate the next batch of results to return, if any.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codecatalyst#ListDevEnvironments": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListDevEnvironmentsRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListDevEnvironmentsResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrives a list of Dev Environments in a project.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListDevEnvironmentsRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.codecatalyst#Filters", + "traits": { + "smithy.api#documentation": "

Information about filters to apply to narrow the results returned in the list.

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

A token returned from a call to this API to indicate the next batch of results to return, if any.

", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + } + } + }, + "com.amazonaws.codecatalyst#ListDevEnvironmentsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the Dev Environments in a project.

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

A token returned from a call to this API to indicate the next batch of results to return, if any.

" + } + } + } + }, + "com.amazonaws.codecatalyst#ListEventLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListEventLogsRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListEventLogsResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of events that occurred during a specified time period in a space. You can use these events to audit user and system activity in a space.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces/{spaceName}/eventLogs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListEventLogsRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "endTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "

The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

The name of the event.

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

A token returned from a call to this API to indicate the next batch of results to return, if any.

", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

", + "smithy.api#range": { + "min": 1, + "max": 250 + } + } + } + } + }, + "com.amazonaws.codecatalyst#ListEventLogsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

" + } + }, + "items": { + "target": "com.amazonaws.codecatalyst#EventLogEntries", + "traits": { + "smithy.api#documentation": "

Information about each event retrieved in the list.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#ListProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListProjectsRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListProjectsResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of projects.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces/{spaceName}/projects", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListProjectsRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "filters": { + "target": "com.amazonaws.codecatalyst#ProjectListFilters", + "traits": { + "smithy.api#documentation": "

Information about filters to apply to narrow the results returned in the list.

" + } + } + } + }, + "com.amazonaws.codecatalyst#ListProjectsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

" + } + }, + "items": { + "target": "com.amazonaws.codecatalyst#ProjectSummaries", + "traits": { + "smithy.api#documentation": "

Information about the projects.

" + } + } + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositories": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoriesRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoriesResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of source repositories in a project.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoriesItem": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryIdString", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the source repository.

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

The name of the source repository.

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

The description of the repository, if any.

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

The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

Information about a source repository returned in a list of source repositories.

" + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoriesItems": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoriesItem" + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoriesRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

", + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + } + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoriesResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoriesItems", + "traits": { + "smithy.api#documentation": "

Information about the source repositories.

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

A token returned from a call to this API to indicate the next batch of results to return, if any.

" + } + } + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoryBranches": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of branches in a specified source repository.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/branches", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesItem": { + "type": "structure", + "members": { + "ref": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchRefString", + "traits": { + "smithy.api#documentation": "

The Git reference name of the branch.

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

The name of the branch.

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

The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

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

The commit ID of the tip of the branch at the time of the request, also known as the head commit.

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

Information about a branch of a source repository returned in a list of branches.

" + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesItems": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesItem" + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString", + "traits": { + "smithy.api#documentation": "

The name of the source repository.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + } + } + }, + "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

" + } + }, + "items": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoryBranchesItems", + "traits": { + "smithy.api#documentation": "

Information about the source branches.

" + } + } + } + }, + "com.amazonaws.codecatalyst#ListSpaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListSpacesRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListSpacesResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of spaces.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListSpacesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + } + } + }, + "com.amazonaws.codecatalyst#ListSpacesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token returned from a call to this API to indicate the next batch of results to return, if any.

" + } + }, + "items": { + "target": "com.amazonaws.codecatalyst#SpaceSummaries", + "traits": { + "smithy.api#documentation": "

Information about the space.

" + } + } + } + }, + "com.amazonaws.codecatalyst#MigrateAwsAccountResource": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "awsAccountName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#NameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.codecatalyst#NotificationChannel": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "notificationChannelId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#NotificationClient": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "notificationClientId": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#Onboarding": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "onboardingId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#OperationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "READONLY", + "value": "READONLY" + }, + { + "name": "MUTATION", + "value": "MUTATION" + } + ] + } + }, + "com.amazonaws.codecatalyst#Organization": { + "type": "resource", + "identifiers": { + "organizationName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#OrganizationArtifactRepository" + }, + { + "target": "com.amazonaws.codecatalyst#OrganizationInvitations" + }, + { + "target": "com.amazonaws.codecatalyst#OrganizationUsers" + } + ] + }, + "com.amazonaws.codecatalyst#OrganizationArtifactRepository": { + "type": "resource", + "identifiers": { + "organizationName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "artifactRepositoryName": { + "target": "com.amazonaws.codecatalyst#ArtifactRepositoryNameString" + } + } + }, + "com.amazonaws.codecatalyst#OrganizationInvitations": { + "type": "resource", + "identifiers": { + "organizationName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "organizationInvitationId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#OrganizationUsers": { + "type": "resource", + "identifiers": { + "organizationName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "username": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#PersistentStorage": { + "type": "structure", + "members": { + "sizeInGiB": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The size of the persistent storage in gigabytes (specifically GiB).

\n \n

Valid values for storage are based on memory sizes in 16GB increments. Valid values are\n 16, 32, and 64.

\n ", + "smithy.api#range": { + "min": 0, + "max": 64 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the persistent storage for a Dev Environment.

" + } + }, + "com.amazonaws.codecatalyst#PersistentStorageConfiguration": { + "type": "structure", + "members": { + "sizeInGiB": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The size of the persistent storage in gigabytes (specifically GiB).

\n \n

Valid values for storage are based on memory sizes in 16GB increments. Valid values are\n 16, 32, and 64.

\n ", + "smithy.api#range": { + "min": 0, + "max": 64 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the configuration of persistent storage for a Dev Environment.

" + } + }, + "com.amazonaws.codecatalyst#Person": { + "type": "resource", + "identifiers": { + "personId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#Project": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + }, + "create": { + "target": "com.amazonaws.codecatalyst#CreateProject" + }, + "read": { + "target": "com.amazonaws.codecatalyst#GetProject" + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListProjects" + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#Action" + }, + { + "target": "com.amazonaws.codecatalyst#ActionVersion" + }, + { + "target": "com.amazonaws.codecatalyst#ArtifactRepository" + }, + { + "target": "com.amazonaws.codecatalyst#CodeCoverageReport" + }, + { + "target": "com.amazonaws.codecatalyst#CodeCoverageResult" + }, + { + "target": "com.amazonaws.codecatalyst#ComputeFleet" + }, + { + "target": "com.amazonaws.codecatalyst#ComputeFleetMigration" + }, + { + "target": "com.amazonaws.codecatalyst#DevEnvironment" + }, + { + "target": "com.amazonaws.codecatalyst#Environment" + }, + { + "target": "com.amazonaws.codecatalyst#ExtensionIssue" + }, + { + "target": "com.amazonaws.codecatalyst#ExtensionIssueScope" + }, + { + "target": "com.amazonaws.codecatalyst#ExternalArtifactRepository" + }, + { + "target": "com.amazonaws.codecatalyst#IssueStore" + }, + { + "target": "com.amazonaws.codecatalyst#IssueStoreMigration" + }, + { + "target": "com.amazonaws.codecatalyst#NotificationChannel" + }, + { + "target": "com.amazonaws.codecatalyst#ProjectNotificationSettings" + }, + { + "target": "com.amazonaws.codecatalyst#ProjectStatus" + }, + { + "target": "com.amazonaws.codecatalyst#ProjectUsers" + }, + { + "target": "com.amazonaws.codecatalyst#PullRequest" + }, + { + "target": "com.amazonaws.codecatalyst#Secret" + }, + { + "target": "com.amazonaws.codecatalyst#SecretMigration" + }, + { + "target": "com.amazonaws.codecatalyst#SoftwareCompositionAnalysisFinding" + }, + { + "target": "com.amazonaws.codecatalyst#SoftwareCompositionAnalysisReport" + }, + { + "target": "com.amazonaws.codecatalyst#SoftwareTestingReport" + }, + { + "target": "com.amazonaws.codecatalyst#SourcePullRequest" + }, + { + "target": "com.amazonaws.codecatalyst#SourcePullRequestToJiraIssueLink" + }, + { + "target": "com.amazonaws.codecatalyst#SourceRepository" + }, + { + "target": "com.amazonaws.codecatalyst#SourceRepositoryMigration" + }, + { + "target": "com.amazonaws.codecatalyst#StaticAnalysisFinding" + }, + { + "target": "com.amazonaws.codecatalyst#StaticAnalysisReport" + }, + { + "target": "com.amazonaws.codecatalyst#StaticWebsite" + }, + { + "target": "com.amazonaws.codecatalyst#TestAction" + }, + { + "target": "com.amazonaws.codecatalyst#TestCaseResult" + }, + { + "target": "com.amazonaws.codecatalyst#TestReport" + }, + { + "target": "com.amazonaws.codecatalyst#TestReportStatus" + }, + { + "target": "com.amazonaws.codecatalyst#Workflow" + }, + { + "target": "com.amazonaws.codecatalyst#WorkflowDraft" + }, + { + "target": "com.amazonaws.codecatalyst#WorkflowRun" + } + ] + }, + "com.amazonaws.codecatalyst#ProjectDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_a-zA-Z0-9.,;:/\\+=?&$% \n\t\r])*$" + } + }, + "com.amazonaws.codecatalyst#ProjectDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\. ][a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.codecatalyst#ProjectInformation": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

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

The system-generated unique ID of the project.

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

Information about a project in a space.

" + } + }, + "com.amazonaws.codecatalyst#ProjectInvitations": { + "type": "resource", + "identifiers": { + "projectInvitationId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#ProjectListFilter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.codecatalyst#FilterKey", + "traits": { + "smithy.api#documentation": "

A key that can be used to sort results.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.codecatalyst#StringList", + "traits": { + "smithy.api#documentation": "

The value of the key.

", + "smithy.api#required": {} + } + }, + "comparisonOperator": { + "target": "com.amazonaws.codecatalyst#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The operator used to compare the fields.

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

nformation about the filter used to narrow the results returned in a list of projects.

" + } + }, + "com.amazonaws.codecatalyst#ProjectListFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#ProjectListFilter" + } + }, + "com.amazonaws.codecatalyst#ProjectNotificationSettings": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#ProjectStatus": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#ProjectSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#ProjectSummary" + } + }, + "com.amazonaws.codecatalyst#ProjectSummary": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

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

The friendly name displayed to users of the project in Amazon CodeCatalyst.

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

The description of the project.

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

Information about a project.

" + } + }, + "com.amazonaws.codecatalyst#ProjectUsers": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "username": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#ProviderIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.codecatalyst#PullRequest": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "pullRequestNumber": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#PullRequestComment": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "pullRequestId": { + "target": "smithy.api#String" + }, + "commentId": { + "target": "smithy.api#String" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#PullRequestCommentReaction" + } + ] + }, + "com.amazonaws.codecatalyst#PullRequestCommentReaction": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "pullRequestId": { + "target": "smithy.api#String" + }, + "commentId": { + "target": "smithy.api#String" + }, + "reactionId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#RegionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 16 + }, + "smithy.api#pattern": "^(us(?:-gov)?|af|ap|ca|cn|eu|sa)-(central|(?:north|south)?(?:east|west)?)-(\\d+)$" + } + }, + "com.amazonaws.codecatalyst#RepositoriesInput": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#RepositoryInput" + } + }, + "com.amazonaws.codecatalyst#RepositoryInput": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString", + "traits": { + "smithy.api#documentation": "

The name of the source repository.

", + "smithy.api#required": {} + } + }, + "branchName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString", + "traits": { + "smithy.api#documentation": "

The name of the branch in a source repository.

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

Information about a repository that will be cloned to a Dev Environment.

" + } + }, + "com.amazonaws.codecatalyst#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.codecatalyst#RoleMappingAssociations": { + "type": "resource" + }, + "com.amazonaws.codecatalyst#RoleMappingAssociationsMigration": { + "type": "resource" + }, + "com.amazonaws.codecatalyst#SSHPublicKey": { + "type": "resource", + "identifiers": { + "SSHPublicKeyId": { + "target": "com.amazonaws.codecatalyst#SSHPublicKeyIdString" + } + } + }, + "com.amazonaws.codecatalyst#SSHPublicKeyIdString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Fa-f0-9]{64}$" + } + }, + "com.amazonaws.codecatalyst#Secret": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "secretName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#SecretMigration": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "secretName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.codecatalyst#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce\n the number of resources, or change the tier if applicable.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.codecatalyst#SoftwareCompositionAnalysisFinding": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "softwareCompositionAnalysisFindingId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#SoftwareCompositionAnalysisReport": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "softwareCompositionAnalysisReportId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#SoftwareTestingReport": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "reportId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SourceBranch": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + }, + "branchName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString" + } + } + }, + "com.amazonaws.codecatalyst#SourceCommit": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + }, + "sourceCommitSha1": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SourceDifferenceMetadata": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + } + } + }, + "com.amazonaws.codecatalyst#SourceFile": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + }, + "sourceFilePath": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SourceFolder": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + }, + "sourceFolderPath": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SourcePullRequest": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourcePullRequestNumber": { + "target": "smithy.api#String" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#SourceRevision" + } + ] + }, + "com.amazonaws.codecatalyst#SourcePullRequestToJiraIssueLink": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "linkId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SourceReferencePolicy": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + }, + "prefixPattern": { + "target": "smithy.api#String" + }, + "referenceType": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SourceRepository": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + } + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositories" + }, + "operations": [ + { + "target": "com.amazonaws.codecatalyst#GetSourceRepositoryCloneUrls" + } + ], + "resources": [ + { + "target": "com.amazonaws.codecatalyst#SourceBranch" + }, + { + "target": "com.amazonaws.codecatalyst#SourceCommit" + }, + { + "target": "com.amazonaws.codecatalyst#SourceDifferenceMetadata" + }, + { + "target": "com.amazonaws.codecatalyst#SourceFile" + }, + { + "target": "com.amazonaws.codecatalyst#SourceFolder" + }, + { + "target": "com.amazonaws.codecatalyst#SourceReferencePolicy" + }, + { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranch" + }, + { + "target": "com.amazonaws.codecatalyst#SourceRepositoryCommit" + }, + { + "target": "com.amazonaws.codecatalyst#SourceRepositoryCommitDifference" + } + ] + }, + "com.amazonaws.codecatalyst#SourceRepositoryBranch": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + }, + "sourceRepositoryBranchName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString" + } + }, + "put": { + "target": "com.amazonaws.codecatalyst#CreateSourceRepositoryBranch" + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListSourceRepositoryBranches" + }, + "traits": { + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryBranchRefString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryBranchString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryCommit": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + }, + "sourceRepositoryCommitId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryCommitDifference": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString" + } + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryIdString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryMigration": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameStringMigration" + } + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(?!.*[.]git$)[\\w\\-.]*$" + } + }, + "com.amazonaws.codecatalyst#SourceRepositoryNameStringMigration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(?!.*[.]git$)[\\w\\-.]*$" + } + }, + "com.amazonaws.codecatalyst#SourceRevision": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "sourcePullRequestNumber": { + "target": "smithy.api#String" + }, + "revisionNumber": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#Space": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + }, + "read": { + "target": "com.amazonaws.codecatalyst#GetSpace" + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListSpaces" + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#ActionLogResource" + }, + { + "target": "com.amazonaws.codecatalyst#AwsAccountOnboardingResource" + }, + { + "target": "com.amazonaws.codecatalyst#AwsAccountResource" + }, + { + "target": "com.amazonaws.codecatalyst#AwsAccountToEnvironmentAssociation" + }, + { + "target": "com.amazonaws.codecatalyst#Bar" + }, + { + "target": "com.amazonaws.codecatalyst#BillingAccountChangeStatus" + }, + { + "target": "com.amazonaws.codecatalyst#Blueprint" + }, + { + "target": "com.amazonaws.codecatalyst#Connection" + }, + { + "target": "com.amazonaws.codecatalyst#DummyData" + }, + { + "target": "com.amazonaws.codecatalyst#EventLogResource" + }, + { + "target": "com.amazonaws.codecatalyst#ExtensionInstallation" + }, + { + "target": "com.amazonaws.codecatalyst#Incident" + }, + { + "target": "com.amazonaws.codecatalyst#Link" + }, + { + "target": "com.amazonaws.codecatalyst#LinkableSourceRepository" + }, + { + "target": "com.amazonaws.codecatalyst#MigrateAwsAccountResource" + }, + { + "target": "com.amazonaws.codecatalyst#NotificationClient" + }, + { + "target": "com.amazonaws.codecatalyst#Onboarding" + }, + { + "target": "com.amazonaws.codecatalyst#Project" + }, + { + "target": "com.amazonaws.codecatalyst#SpaceInvitations" + }, + { + "target": "com.amazonaws.codecatalyst#SpaceUsageReport" + }, + { + "target": "com.amazonaws.codecatalyst#SpaceUsers" + }, + { + "target": "com.amazonaws.codecatalyst#Subscription" + }, + { + "target": "com.amazonaws.codecatalyst#UsageReport" + }, + { + "target": "com.amazonaws.codecatalyst#UserNotificationSettings" + } + ] + }, + "com.amazonaws.codecatalyst#SpaceInvitations": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "spaceInvitationId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#SpaceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#SpaceSummary" + } + }, + "com.amazonaws.codecatalyst#SpaceSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

\n We need to know what this is and the basic usage information so that third-party developers know how to use this data type.\n

", + "smithy.api#required": {} + } + }, + "regionName": { + "target": "com.amazonaws.codecatalyst#RegionString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region\n where the space exists.

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

The friendly name of the space displayed to users.

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

The description of the space.

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

Information about an space.

" + } + }, + "com.amazonaws.codecatalyst#SpaceUsageReport": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#SpaceUsers": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "username": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#StartDevEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#StartDevEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#StartDevEnvironmentResponse" + }, + "traits": { + "smithy.api#documentation": "

Starts a specified Dev Environment and puts it into an active state.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/start", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#StartDevEnvironmentRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "ides": { + "target": "com.amazonaws.codecatalyst#IdeConfigurationList", + "traits": { + "smithy.api#documentation": "

Information about the integrated development environment (IDE) configured for a Dev Environment.

" + } + }, + "instanceType": { + "target": "com.amazonaws.codecatalyst#InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instace type to use for the Dev Environment.

" + } + }, + "inactivityTimeoutMinutes": { + "target": "com.amazonaws.codecatalyst#InactivityTimeoutMinutes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

" + } + } + } + }, + "com.amazonaws.codecatalyst#StartDevEnvironmentResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the Dev Environment.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#StartDevEnvironmentSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#StartDevEnvironmentSessionRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#StartDevEnvironmentSessionResponse" + }, + "traits": { + "smithy.api#documentation": "

Starts a session for a specified Dev Environment.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session", + "code": 200 + } + } + }, + "com.amazonaws.codecatalyst#StartDevEnvironmentSessionRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "sessionConfiguration": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentSessionConfiguration", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#StartDevEnvironmentSessionResponse": { + "type": "structure", + "members": { + "accessDetails": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentAccessDetails", + "traits": { + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment session.

", + "smithy.api#length": { + "min": 1, + "max": 96 + } + } + }, + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + } + } + }, + "com.amazonaws.codecatalyst#StaticAnalysisFinding": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "findingId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#StaticAnalysisReport": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "reportId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#StaticWebsite": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#StatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.codecatalyst#StopDevEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#StopDevEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#StopDevEnvironmentResponse" + }, + "traits": { + "smithy.api#documentation": "

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/stop", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#StopDevEnvironmentRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + } + } + }, + "com.amazonaws.codecatalyst#StopDevEnvironmentResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the Dev Environment.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.codecatalyst#Subscription": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + }, + "read": { + "target": "com.amazonaws.codecatalyst#GetSubscription" + } + }, + "com.amazonaws.codecatalyst#TestAction": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "testActionRunId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#TestCaseResult": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "testCaseResultId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#TestReport": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "testReportId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + }, + "com.amazonaws.codecatalyst#TestReportStatus": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "reportStatusId": { + "target": "smithy.api#String" + } + } + }, + "com.amazonaws.codecatalyst#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.codecatalyst#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.codecatalyst#UpdateDevEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#UpdateDevEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#UpdateDevEnvironmentResponse" + }, + "traits": { + "smithy.api#documentation": "

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#UpdateDevEnvironmentRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "alias": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*$" + } + }, + "ides": { + "target": "com.amazonaws.codecatalyst#IdeConfigurationList", + "traits": { + "smithy.api#documentation": "

Information about the integrated development environment (IDE) configured for a Dev Environment.

" + } + }, + "instanceType": { + "target": "com.amazonaws.codecatalyst#InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instace type to use for the Dev Environment.

\n \n

Changing this value will cause a restart of the Dev Environment if it is running.

\n " + } + }, + "inactivityTimeoutMinutes": { + "target": "com.amazonaws.codecatalyst#InactivityTimeoutMinutes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. \n Only whole integers are allowed. Dev Environments consume compute minutes when running.

\n \n

Changing this value will cause a restart of the Dev Environment if it is running.

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

A user-specified idempotency token. Idempotency ensures that an API request completes only once. \n With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

" + } + } + } + }, + "com.amazonaws.codecatalyst#UpdateDevEnvironmentResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the Dev Environment.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the space.

", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "

The name of the project in the space.

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

The user-specified alias for the Dev Environment.

", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*$" + } + }, + "ides": { + "target": "com.amazonaws.codecatalyst#IdeConfigurationList", + "traits": { + "smithy.api#documentation": "

Information about the integrated development environment (IDE) configured for the Dev Environment.

" + } + }, + "instanceType": { + "target": "com.amazonaws.codecatalyst#InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instace type to use for the Dev Environment.

" + } + }, + "inactivityTimeoutMinutes": { + "target": "com.amazonaws.codecatalyst#InactivityTimeoutMinutes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

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

A user-specified idempotency token. Idempotency ensures that an API request completes only once. \n With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

" + } + } + } + }, + "com.amazonaws.codecatalyst#UsageReport": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#UserIdentity": { + "type": "structure", + "members": { + "userType": { + "target": "com.amazonaws.codecatalyst#UserType", + "traits": { + "smithy.api#documentation": "

The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.

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

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

The display name of the user in Amazon CodeCatalyst.

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

The Amazon Web Services account number of the user in Amazon Web Services, if any.

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

Information about a user whose activity is recorded in an event for a space.

" + } + }, + "com.amazonaws.codecatalyst#UserNotificationSettings": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#UserType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "USER", + "value": "USER" + }, + { + "name": "AWS_ACCOUNT", + "value": "AWS_ACCOUNT" + }, + { + "name": "UNKNOWN", + "value": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.codecatalyst#Uuid": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.codecatalyst#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.codecatalyst#VerifySession": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.codecatalyst#VerifySessionResponse" + }, + "traits": { + "smithy.api#documentation": "

Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.

", + "smithy.api#http": { + "method": "GET", + "uri": "/session", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#VerifySessionResponse": { + "type": "structure", + "members": { + "identity": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID of the user in Amazon CodeCatalyst.

", + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + } + } + }, + "com.amazonaws.codecatalyst#Workflow": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#WorkflowState" + } + ] + }, + "com.amazonaws.codecatalyst#WorkflowDraft": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + } + } + }, + "com.amazonaws.codecatalyst#WorkflowRun": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid" + }, + "workflowRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + }, + "resources": [ + { + "target": "com.amazonaws.codecatalyst#ActionRun" + } + ] + }, + "com.amazonaws.codecatalyst#WorkflowState": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/comprehend.json b/codegen/sdk-codegen/aws-models/comprehend.json index 5b9154538f4..42b10ee0f33 100644 --- a/codegen/sdk-codegen/aws-models/comprehend.json +++ b/codegen/sdk-codegen/aws-models/comprehend.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -49,18 +49,20 @@ } }, "com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PLAIN_TEXT_DOCUMENT", - "name": "PLAIN_TEXT_DOCUMENT" - }, - { - "value": "SEMI_STRUCTURED_DOCUMENT", - "name": "SEMI_STRUCTURED_DOCUMENT" + "type": "enum", + "members": { + "PLAIN_TEXT_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT_DOCUMENT" + } + }, + "SEMI_STRUCTURED_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMI_STRUCTURED_DOCUMENT" } - ] + } } }, "com.amazonaws.comprehend#AugmentedManifestsListItem": { @@ -690,6 +692,157 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.comprehend#Block": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Unique identifier for the block.

" + } + }, + "BlockType": { + "target": "com.amazonaws.comprehend#BlockType", + "traits": { + "smithy.api#documentation": "

The block represents a line of text or one word of text.

\n " + } + }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The word or line of text extracted from the block.

" + } + }, + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number where the block appears.

" + } + }, + "Geometry": { + "target": "com.amazonaws.comprehend#Geometry", + "traits": { + "smithy.api#documentation": "

Co-ordinates of the rectangle or polygon that contains the text.

" + } + }, + "Relationships": { + "target": "com.amazonaws.comprehend#ListOfRelationships", + "traits": { + "smithy.api#documentation": "

A list of child blocks of the current block. \n For example, a LINE object has child blocks for each WORD block that's part of the line of text.

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

Information about each word or line of text in the input document.

\n

For additional information, see Block in the Amazon Textract API reference.

" + } + }, + "com.amazonaws.comprehend#BlockReference": { + "type": "structure", + "members": { + "BlockId": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Unique identifier for the block.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the start of the block within its parent block.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the end of the block within its parent block.

" + } + }, + "ChildBlocks": { + "target": "com.amazonaws.comprehend#ListOfChildBlocks", + "traits": { + "smithy.api#documentation": "

List of child blocks within this block.

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

A reference to a block.

" + } + }, + "com.amazonaws.comprehend#BlockType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORD" + } + } + } + }, + "com.amazonaws.comprehend#BoundingBox": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The height of the bounding box as a ratio of the overall document page height.

" + } + }, + "Left": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The left coordinate of the bounding box as a ratio of overall document page width.

" + } + }, + "Top": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The top coordinate of the bounding box as a ratio of overall document page height.

" + } + }, + "Width": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The width of the bounding box as a ratio of the overall document page width.

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

The bounding box around the detected page\n or around an element on a document page. \n The left (x-coordinate) and top (y-coordinate) are coordinates that \n represent the top and left sides of the bounding box. Note that the upper-left \n corner of the image is the origin (0,0).

\n

For additional information, see BoundingBox in the Amazon Textract API reference.

" + } + }, + "com.amazonaws.comprehend#ChildBlock": { + "type": "structure", + "members": { + "ChildBlockId": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Unique identifier for the child block.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the start of the child block within its parent block.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the end of the child block within its parent block.

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

Nested block contained within a block.

" + } + }, "com.amazonaws.comprehend#ClassifierEvaluationMetrics": { "type": "structure", "members": { @@ -802,7 +955,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new document classification request to analyze a single document in real-time,\n using a previously created and trained custom model and an endpoint.

" + "smithy.api#documentation": "

Creates a new document classification request to analyze a single document in real-time,\n using a previously created and trained custom model and an endpoint.

\n

You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

\n

If the system detects errors while processing a page in the input document, \n the API response includes an entry in Errors that describes the errors.

\n

If the system detects a document-level error in your input document, the API returns an \n InvalidRequestException error response. \n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide. \n

" } }, "com.amazonaws.comprehend#ClassifyDocumentRequest": { @@ -811,8 +964,7 @@ "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "

The document text to be analyzed.

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

The document text to be analyzed. If you enter text using this parameter,\n do not use the Bytes parameter.

" } }, "EndpointArn": { @@ -821,6 +973,18 @@ "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing endpoints.

", "smithy.api#required": {} } + }, + "Bytes": { + "target": "com.amazonaws.comprehend#SemiStructuredDocumentBlob", + "traits": { + "smithy.api#documentation": "

Use the Bytes parameter to input a text, PDF, Word or image file.\n You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText \n or AnalyzeDocument output file.

\n

Provide the input document as a sequence of base64-encoded bytes. \n If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode \n the document file bytes for you.

\n

The maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.

\n

If you use the Bytes parameter, do not use the Text parameter.

" + } + }, + "DocumentReaderConfig": { + "target": "com.amazonaws.comprehend#DocumentReaderConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text \n from PDF documents and image files.

" + } } } }, @@ -838,6 +1002,24 @@ "traits": { "smithy.api#documentation": "

The labels used the document being analyzed. These are used for multi-label trained\n models. Individual labels represent different categories that are related in some manner and\n are not mutually exclusive. For example, a movie can be just an action movie, or it can be an\n action movie, a science fiction movie, and a comedy, all at the same time.

" } + }, + "DocumentMetadata": { + "target": "com.amazonaws.comprehend#DocumentMetadata", + "traits": { + "smithy.api#documentation": "

Extraction information about the document. This field is present\n in the response only if your request includes the Byte parameter.

" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#ListOfDocumentType", + "traits": { + "smithy.api#documentation": "

The document type for each page in the input document. This field is present\n in the response only if your request includes the Byte parameter.

" + } + }, + "Errors": { + "target": "com.amazonaws.comprehend#ListOfErrors", + "traits": { + "smithy.api#documentation": "

Page-level errors that the system detected while processing the input document. \n The field is empty if the system encountered no errors.

" + } } }, "traits": { @@ -906,21 +1088,6 @@ }, "com.amazonaws.comprehend#Comprehend_20171127": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Comprehend", - "arnNamespace": "comprehend", - "cloudFormationName": "Comprehend", - "cloudTrailEventSource": "comprehend.amazonaws.com", - "endpointPrefix": "comprehend" - }, - "aws.auth#sigv4": { - "name": "comprehend" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Comprehend is an AWS service for gaining insight into the content of documents.\n Use these actions to determine the topics contained in your documents, the topics they\n discuss, the predominant sentiment expressed in them, the predominant language used, and\n more.

", - "smithy.api#title": "Amazon Comprehend" - }, "version": "2017-11-27", "operations": [ { @@ -1142,7 +1309,1572 @@ { "target": "com.amazonaws.comprehend#UpdateEndpoint" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Comprehend", + "arnNamespace": "comprehend", + "cloudFormationName": "Comprehend", + "cloudTrailEventSource": "comprehend.amazonaws.com", + "endpointPrefix": "comprehend" + }, + "aws.auth#sigv4": { + "name": "comprehend" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon Comprehend is an AWS service for gaining insight into the content of documents.\n Use these actions to determine the topics contained in your documents, the topics they\n discuss, the predominant sentiment expressed in them, the predominant language used, and\n more.

", + "smithy.api#title": "Amazon Comprehend", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } }, "com.amazonaws.comprehend#ConcurrentModificationException": { "type": "structure", @@ -1528,7 +3260,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

You can specify any of the following languages supported by Amazon Comprehend: English\n (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\").\n All documents must be in the same language.

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

You can specify any of the following languages: English\n (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\").\n If you plan to use this entity recognizer with PDF, Word, or image input files, you must \n specify English as the language. \n All training documents must be in the same language.

", "smithy.api#required": {} } }, @@ -2243,7 +3975,7 @@ "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy to describe.

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

The Amazon Resource Name (ARN) of the custom model version that has the resource policy.

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

Inspects text for named entities, and returns information about them. For more\n information, about named entities, see\n Entities in the Comprehend Developer Guide.

" + "smithy.api#documentation": "

Detects named entities in input text when you use the pre-trained model. \n Detects custom entities if you have a custom entity recognition model.

\n

\n When detecting named entities using the pre-trained model, use plain text as the input.\n For more information about named entities, see\n Entities in the Comprehend Developer Guide.

\n

When you use a custom entity recognition model, \n you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

\n

If the system detects errors while processing a page in the input document, the API response \n includes an entry in Errors for each error.

\n

If the system detects a document-level error in your input document, the API returns an \n InvalidRequestException error response. \n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide. \n

" } }, "com.amazonaws.comprehend#DetectEntitiesRequest": { @@ -2509,14 +4241,13 @@ "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "

A UTF-8 text string. The maximum string size is 100 KB.

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

A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter,\n do not use the Bytes parameter.

" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

\n

If your request includes the endpoint for a custom entity recognition model, Amazon\n Comprehend uses the language of your custom model, and it ignores any language code that you\n specify here.

" + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon\n Comprehend uses the language of your custom model, and it ignores any language code that you\n specify here.

\n

All input documents must be in the same language.

" } }, "EndpointArn": { @@ -2524,6 +4255,18 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name of an endpoint that is associated with a custom entity\n recognition model. Provide an endpoint if you want to detect entities by using your own custom\n model instead of the default model that is used by Amazon Comprehend.

\n

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and\n it ignores any language code that you provide in your request.

\n

For information about endpoints, see Managing endpoints.

" } + }, + "Bytes": { + "target": "com.amazonaws.comprehend#SemiStructuredDocumentBlob", + "traits": { + "smithy.api#documentation": "

This field applies only when you use a custom entity recognition model that\n was trained with PDF annotations. For other cases, \n enter your text input in the Text field.

\n

\n Use the Bytes parameter to input a text, PDF, Word or image file.\n Using a plain-text file in the Bytes parameter is equivelent to using the \n Text parameter (the Entities field in the response is identical).

\n

You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText \n or AnalyzeDocument output file.

\n

Provide the input document as a sequence of base64-encoded bytes. \n If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode \n the document file bytes for you.

\n

The maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.

\n

If you use the Bytes parameter, do not use the Text parameter.

" + } + }, + "DocumentReaderConfig": { + "target": "com.amazonaws.comprehend#DocumentReaderConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text \n from PDF documents and image files.

" + } } } }, @@ -2535,6 +4278,30 @@ "traits": { "smithy.api#documentation": "

A collection of entities identified in the input text. For each entity, the response\n provides the entity text, entity type, where the entity text begins and ends, and the level of\n confidence that Amazon Comprehend has in the detection.

\n

If your request uses a custom entity recognition model, Amazon Comprehend detects the\n entities that the model is trained to recognize. Otherwise, it detects the default entity\n types. For a list of default entity types, see\n Entities in the Comprehend Developer Guide.\n

" } + }, + "DocumentMetadata": { + "target": "com.amazonaws.comprehend#DocumentMetadata", + "traits": { + "smithy.api#documentation": "

Information about the document, discovered during text extraction. This field is present\n in the response only if your request used the Byte parameter.

" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#ListOfDocumentType", + "traits": { + "smithy.api#documentation": "

The document type for each page in the input document. This field is present\n in the response only if your request used the Byte parameter.

" + } + }, + "Blocks": { + "target": "com.amazonaws.comprehend#ListOfBlocks", + "traits": { + "smithy.api#documentation": "

Information about each block of text in the input document. \n Blocks are nested. A page block contains a block for each line of text, \n which contains a block for each word.

\n

The Block content for a Word input document does not include a Geometry field.

\n

The Block field is not present in the response for plain-text inputs.

" + } + }, + "Errors": { + "target": "com.amazonaws.comprehend#ListOfErrors", + "traits": { + "smithy.api#documentation": "

Page-level errors that the system detected while processing the input document. \n The field is empty if the system encountered no errors.

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

The confidence score that Amazon Comprehend has this class correctly attributed.

" } + }, + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number in the input document. This field is present\n in the response only if your request includes the Byte parameter.

" + } } }, "traits": { @@ -3000,18 +4773,20 @@ } }, "com.amazonaws.comprehend#DocumentClassifierDataFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPREHEND_CSV", - "name": "COMPREHEND_CSV" - }, - { - "value": "AUGMENTED_MANIFEST", - "name": "AUGMENTED_MANIFEST" + "type": "enum", + "members": { + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPREHEND_CSV" + } + }, + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUGMENTED_MANIFEST" } - ] + } } }, "com.amazonaws.comprehend#DocumentClassifierEndpointArn": { @@ -3095,18 +4870,20 @@ } }, "com.amazonaws.comprehend#DocumentClassifierMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MULTI_CLASS", - "name": "MULTI_CLASS" - }, - { - "value": "MULTI_LABEL", - "name": "MULTI_LABEL" + "type": "enum", + "members": { + "MULTI_CLASS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_CLASS" + } + }, + "MULTI_LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_LABEL" } - ] + } } }, "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig": { @@ -3309,56 +5086,90 @@ "traits": { "smithy.api#documentation": "

The confidence score that Amazon Comprehend has this label correctly attributed.

" } + }, + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number where the label occurs. This field is present\n in the response only if your request includes the Byte parameter.

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

Specifies one of the label or labels that categorize the document being analyzed.

" } }, - "com.amazonaws.comprehend#DocumentReadAction": { - "type": "string", + "com.amazonaws.comprehend#DocumentMetadata": { + "type": "structure", + "members": { + "Pages": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Number of pages in the document.

" + } + }, + "ExtractedCharacters": { + "target": "com.amazonaws.comprehend#ListOfExtractedCharacters", + "traits": { + "smithy.api#documentation": "

List of pages in the document, with the number of characters extracted from each page.

" + } + } + }, "traits": { - "smithy.api#enum": [ - { - "value": "TEXTRACT_DETECT_DOCUMENT_TEXT", - "name": "TEXTRACT_DETECT_DOCUMENT_TEXT" - }, - { - "value": "TEXTRACT_ANALYZE_DOCUMENT", - "name": "TEXTRACT_ANALYZE_DOCUMENT" + "smithy.api#documentation": "

Information about the document, discovered during text extraction.

" + } + }, + "com.amazonaws.comprehend#DocumentReadAction": { + "type": "enum", + "members": { + "TEXTRACT_DETECT_DOCUMENT_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT" } - ] + }, + "TEXTRACT_ANALYZE_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_ANALYZE_DOCUMENT" + } + } } }, "com.amazonaws.comprehend#DocumentReadFeatureTypes": { - "type": "string", - "traits": { - "smithy.api#documentation": "

A list of the types of analyses to perform. This field specifies what feature types\n need to be extracted from the document where entity recognition is expected.

\n\n ", - "smithy.api#enum": [ - { - "value": "TABLES", - "name": "TABLES" - }, - { - "value": "FORMS", - "name": "FORMS" + "type": "enum", + "members": { + "TABLES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABLES" + } + }, + "FORMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORMS" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT \n as the read action, you must specify one or both of the following values:

\n " } }, "com.amazonaws.comprehend#DocumentReadMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SERVICE_DEFAULT", - "name": "SERVICE_DEFAULT" - }, - { - "value": "FORCE_DOCUMENT_READ_ACTION", - "name": "FORCE_DOCUMENT_READ_ACTION" + "type": "enum", + "members": { + "SERVICE_DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_DEFAULT" } - ] + }, + "FORCE_DOCUMENT_READ_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORCE_DOCUMENT_READ_ACTION" + } + } } }, "com.amazonaws.comprehend#DocumentReaderConfig": { @@ -3367,32 +5178,99 @@ "DocumentReadAction": { "target": "com.amazonaws.comprehend#DocumentReadAction", "traits": { - "smithy.api#documentation": "

This enum field will start with two values which will apply to PDFs:

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

This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.\n Enter one of the following values:

\n ", "smithy.api#required": {} } }, "DocumentReadMode": { "target": "com.amazonaws.comprehend#DocumentReadMode", "traits": { - "smithy.api#documentation": "

This enum field provides two values:

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

Determines the text extraction actions for PDF files. Enter one of the following values:

\n " } }, "FeatureTypes": { "target": "com.amazonaws.comprehend#ListOfDocumentReadFeatureTypes", "traits": { - "smithy.api#documentation": "

Specifies how the text in an input file should be processed:

" + "smithy.api#documentation": "

Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT \n as the read action, you must specify one or both of the following values:

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

The input properties for a topic detection job.

" + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

\n

By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

\n \n

\n DocumentReaderConfig does not apply to plain text files or Word files.

\n

\n For image files and PDF documents, you can override these default actions using the fields listed below. \n For more information, see \n Setting text extraction options. \n

" } }, - "com.amazonaws.comprehend#DominantLanguage": { - "type": "structure", + "com.amazonaws.comprehend#DocumentType": { + "type": "enum", "members": { - "LanguageCode": { - "target": "com.amazonaws.comprehend#String", + "NATIVE_PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_PDF" + } + }, + "SCANNED_PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCANNED_PDF" + } + }, + "MS_WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS_WORD" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON" + } + }, + "TEXTRACT_ANALYZE_DOCUMENT_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_ANALYZE_DOCUMENT_JSON" + } + } + } + }, + "com.amazonaws.comprehend#DocumentTypeListItem": { + "type": "structure", + "members": { + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number.

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

Document type.

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

Document type for each page in the document.

" + } + }, + "com.amazonaws.comprehend#DominantLanguage": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "

The RFC 5646 language code for the dominant language. For more information about RFC\n 5646, see Tags for Identifying\n Languages on the IETF Tools web site.

" } @@ -3527,10 +5405,7 @@ } }, "com.amazonaws.comprehend#Double": { - "type": "double", - "traits": { - "smithy.api#box": {} - } + "type": "double" }, "com.amazonaws.comprehend#EndpointFilter": { "type": "structure", @@ -3645,30 +5520,38 @@ } }, "com.amazonaws.comprehend#EndpointStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "IN_SERVICE", - "name": "IN_SERVICE" - }, - { - "value": "UPDATING", - "name": "UPDATING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_SERVICE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" } - ] + } } }, "com.amazonaws.comprehend#EntitiesDetectionJobFilter": { @@ -3813,7 +5696,7 @@ "Type": { "target": "com.amazonaws.comprehend#EntityType", "traits": { - "smithy.api#documentation": "

The entity's type.

" + "smithy.api#documentation": "

The entity type. For entity detection using the built-in model, this field contains one of the \n standard entity types listed below.

\n

For custom entity detection, this field contains one of the \n entity types that you specified when you trained your custom model.

" } }, "Text": { @@ -3825,13 +5708,19 @@ "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n entity.

" + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n entity.

\n

This field is empty for non-text input.

" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n entity.

" + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n entity.

\n

This field is empty for non-text input.

" + } + }, + "BlockReferences": { + "target": "com.amazonaws.comprehend#ListOfBlockReferences", + "traits": { + "smithy.api#documentation": "

A reference to each block for this entity. This field is empty for plain-text input.

" } } }, @@ -3897,18 +5786,20 @@ } }, "com.amazonaws.comprehend#EntityRecognizerDataFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPREHEND_CSV", - "name": "COMPREHEND_CSV" - }, - { - "value": "AUGMENTED_MANIFEST", - "name": "AUGMENTED_MANIFEST" + "type": "enum", + "members": { + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPREHEND_CSV" } - ] + }, + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUGMENTED_MANIFEST" + } + } } }, "com.amazonaws.comprehend#EntityRecognizerDocuments": { @@ -4286,46 +6177,62 @@ } }, "com.amazonaws.comprehend#EntityType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PERSON", - "name": "PERSON" - }, - { - "value": "LOCATION", - "name": "LOCATION" - }, - { - "value": "ORGANIZATION", - "name": "ORGANIZATION" - }, - { - "value": "COMMERCIAL_ITEM", - "name": "COMMERCIAL_ITEM" - }, - { - "value": "EVENT", - "name": "EVENT" - }, - { - "value": "DATE", - "name": "DATE" - }, - { - "value": "QUANTITY", - "name": "QUANTITY" - }, - { - "value": "TITLE", - "name": "TITLE" - }, - { - "value": "OTHER", - "name": "OTHER" + "type": "enum", + "members": { + "PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSON" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" + } + }, + "ORGANIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORGANIZATION" + } + }, + "COMMERCIAL_ITEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMERCIAL_ITEM" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "QUANTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUANTITY" + } + }, + "TITLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TITLE" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" } - ] + } } }, "com.amazonaws.comprehend#EntityTypeName": { @@ -4385,6 +6292,32 @@ "smithy.api#documentation": "

An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.

" } }, + "com.amazonaws.comprehend#ErrorsListItem": { + "type": "structure", + "members": { + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number where the error occurred.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.comprehend#PageBasedErrorCode", + "traits": { + "smithy.api#documentation": "

Error code for the cause of the error.

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

Text message explaining the reason for the error.

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

Text extraction encountered one or more page-level errors in the input document.

\n

The ErrorCode contains one of the following values:

\n " + } + }, "com.amazonaws.comprehend#EventTypeString": { "type": "string", "traits": { @@ -4513,10 +6446,47 @@ "target": "com.amazonaws.comprehend#EventsDetectionJobProperties" } }, + "com.amazonaws.comprehend#ExtractedCharactersListItem": { + "type": "structure", + "members": { + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number.

" + } + }, + "Count": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Number of characters extracted from each page.

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

Array of the number of characters extracted from each page.

" + } + }, "com.amazonaws.comprehend#Float": { - "type": "float", + "type": "float" + }, + "com.amazonaws.comprehend#Geometry": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.comprehend#BoundingBox", + "traits": { + "smithy.api#documentation": "

An axis-aligned coarse representation of the location of the recognized item on the \n document page.

" + } + }, + "Polygon": { + "target": "com.amazonaws.comprehend#Polygon", + "traits": { + "smithy.api#documentation": "

Within the bounding box, a fine-grained polygon around the recognized item.

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

Information about the location of items on a document page.

\n

For additional information, see Geometry in the Amazon Textract API reference.

" } }, "com.amazonaws.comprehend#IamRoleArn": { @@ -4626,7 +6596,6 @@ "com.amazonaws.comprehend#InferenceUnitsInteger": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -4651,34 +6620,33 @@ "DocumentReaderConfig": { "target": "com.amazonaws.comprehend#DocumentReaderConfig", "traits": { - "smithy.api#documentation": "

The document reader config field applies only for InputDataConfig of\n StartEntitiesDetectionJob.

\n

Use DocumentReaderConfig to provide specifications about how you want your inference\n documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom\n inference.

" + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text \n from PDF documents and image files.

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

The input properties for an inference job.

" + "smithy.api#documentation": "

The input properties for an inference job. The document reader config field applies \n only to non-text inputs for custom analysis.

" } }, "com.amazonaws.comprehend#InputFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ONE_DOC_PER_FILE", - "name": "ONE_DOC_PER_FILE" - }, - { - "value": "ONE_DOC_PER_LINE", - "name": "ONE_DOC_PER_LINE" + "type": "enum", + "members": { + "ONE_DOC_PER_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_DOC_PER_FILE" + } + }, + "ONE_DOC_PER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_DOC_PER_LINE" } - ] + } } }, "com.amazonaws.comprehend#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.comprehend#InternalServerException": { "type": "structure", @@ -4706,11 +6674,60 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.comprehend#InvalidRequestDetail": { + "type": "structure", + "members": { + "Reason": { + "target": "com.amazonaws.comprehend#InvalidRequestDetailReason", + "traits": { + "smithy.api#documentation": "

Reason code is INVALID_DOCUMENT.

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

Provides additional detail about why the request failed:

\n " + } + }, + "com.amazonaws.comprehend#InvalidRequestDetailReason": { + "type": "enum", + "members": { + "DOCUMENT_SIZE_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_SIZE_EXCEEDED" + } + }, + "UNSUPPORTED_DOC_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_DOC_TYPE" + } + }, + "PAGE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_LIMIT_EXCEEDED" + } + }, + "TEXTRACT_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_ACCESS_DENIED" + } + } + } + }, "com.amazonaws.comprehend#InvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" + }, + "Reason": { + "target": "com.amazonaws.comprehend#InvalidRequestReason" + }, + "Detail": { + "target": "com.amazonaws.comprehend#InvalidRequestDetail" } }, "traits": { @@ -4719,6 +6736,17 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.comprehend#InvalidRequestReason": { + "type": "enum", + "members": { + "INVALID_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DOCUMENT" + } + } + } + }, "com.amazonaws.comprehend#JobId": { "type": "string", "traits": { @@ -4753,34 +6781,44 @@ } }, "com.amazonaws.comprehend#JobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBMITTED", - "name": "SUBMITTED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "STOP_REQUESTED", - "name": "STOP_REQUESTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" } - ] + } } }, "com.amazonaws.comprehend#KeyPhrase": { @@ -4973,70 +7011,92 @@ } }, "com.amazonaws.comprehend#LanguageCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "en", - "name": "EN" - }, - { - "value": "es", - "name": "ES" - }, - { - "value": "fr", - "name": "FR" - }, - { - "value": "de", - "name": "DE" - }, - { - "value": "it", - "name": "IT" - }, - { - "value": "pt", - "name": "PT" - }, - { - "value": "ar", - "name": "AR" - }, - { - "value": "hi", - "name": "HI" - }, - { - "value": "ja", - "name": "JA" - }, - { - "value": "ko", - "name": "KO" - }, - { - "value": "zh", - "name": "ZH" - }, - { - "value": "zh-TW", - "name": "ZH_TW" + "type": "enum", + "members": { + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" } - ] - } - }, - "com.amazonaws.comprehend#ListDocumentClassificationJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsRequest" - }, - "output": { - "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsResponse" - }, - "errors": [ - { + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt" + } + }, + "AR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ar" + } + }, + "HI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi" + } + }, + "JA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja" + } + }, + "KO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko" + } + }, + "ZH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "ZH_TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-TW" + } + } + } + }, + "com.amazonaws.comprehend#ListDocumentClassificationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsResponse" + }, + "errors": [ + { "target": "com.amazonaws.comprehend#InternalServerException" }, { @@ -5322,7 +7382,13 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all existing endpoints that you've created.\n For information about endpoints, see Managing endpoints.

" + "smithy.api#documentation": "

Gets a list of all existing endpoints that you've created.\n For information about endpoints, see Managing endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EndpointPropertiesList", + "pageSize": "MaxResults" + } } }, "com.amazonaws.comprehend#ListEndpointsRequest": { @@ -5711,6 +7777,24 @@ } } }, + "com.amazonaws.comprehend#ListOfBlockReferences": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BlockReference" + } + }, + "com.amazonaws.comprehend#ListOfBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Block" + } + }, + "com.amazonaws.comprehend#ListOfChildBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ChildBlock" + } + }, "com.amazonaws.comprehend#ListOfClasses": { "type": "list", "member": { @@ -5771,6 +7855,12 @@ } } }, + "com.amazonaws.comprehend#ListOfDocumentType": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentTypeListItem" + } + }, "com.amazonaws.comprehend#ListOfDominantLanguages": { "type": "list", "member": { @@ -5789,6 +7879,18 @@ "target": "com.amazonaws.comprehend#EntityLabel" } }, + "com.amazonaws.comprehend#ListOfErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ErrorsListItem" + } + }, + "com.amazonaws.comprehend#ListOfExtractedCharacters": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ExtractedCharactersListItem" + } + }, "com.amazonaws.comprehend#ListOfKeyPhrases": { "type": "list", "member": { @@ -5819,6 +7921,12 @@ "target": "com.amazonaws.comprehend#PiiEntityType" } }, + "com.amazonaws.comprehend#ListOfRelationships": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#RelationshipsListItem" + } + }, "com.amazonaws.comprehend#ListOfSyntaxTokens": { "type": "list", "member": { @@ -5854,7 +7962,13 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of the PII entity detection jobs that you have submitted.

" + "smithy.api#documentation": "

Gets a list of the PII entity detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PiiEntitiesDetectionJobPropertiesList", + "pageSize": "MaxResults" + } } }, "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsRequest": { @@ -6175,7 +8289,6 @@ "com.amazonaws.comprehend#MaxResultsInteger": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 @@ -6200,44 +8313,55 @@ } }, "com.amazonaws.comprehend#ModelStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBMITTED", - "name": "SUBMITTED" - }, - { - "value": "TRAINING", - "name": "TRAINING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "STOP_REQUESTED", - "name": "STOP_REQUESTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "IN_ERROR", - "name": "IN_ERROR" - }, - { - "value": "TRAINED", - "name": "TRAINED" + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" } - ] + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "IN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_ERROR" + } + }, + "TRAINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINED" + } + } } }, "com.amazonaws.comprehend#NumberOfTopicsInteger": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -6265,6 +8389,41 @@ "smithy.api#documentation": "

Provides configuration parameters for the output of inference jobs.

\n

" } }, + "com.amazonaws.comprehend#PageBasedErrorCode": { + "type": "enum", + "members": { + "TEXTRACT_BAD_PAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_BAD_PAGE" + } + }, + "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED" + } + }, + "PAGE_CHARACTERS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_CHARACTERS_EXCEEDED" + } + }, + "PAGE_SIZE_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_SIZE_EXCEEDED" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, "com.amazonaws.comprehend#PartOfSpeechTag": { "type": "structure", "members": { @@ -6286,82 +8445,116 @@ } }, "com.amazonaws.comprehend#PartOfSpeechTagType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADJ", - "name": "ADJ" - }, - { - "value": "ADP", - "name": "ADP" - }, - { - "value": "ADV", - "name": "ADV" - }, - { - "value": "AUX", - "name": "AUX" - }, - { - "value": "CONJ", - "name": "CONJ" - }, - { - "value": "CCONJ", - "name": "CCONJ" - }, - { - "value": "DET", - "name": "DET" - }, - { - "value": "INTJ", - "name": "INTJ" - }, - { - "value": "NOUN", - "name": "NOUN" - }, - { - "value": "NUM", - "name": "NUM" - }, - { - "value": "O", - "name": "O" - }, - { - "value": "PART", - "name": "PART" - }, - { - "value": "PRON", - "name": "PRON" - }, - { - "value": "PROPN", - "name": "PROPN" - }, - { - "value": "PUNCT", - "name": "PUNCT" - }, - { - "value": "SCONJ", - "name": "SCONJ" - }, - { - "value": "SYM", - "name": "SYM" - }, - { - "value": "VERB", - "name": "VERB" + "type": "enum", + "members": { + "ADJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADJ" + } + }, + "ADP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADP" + } + }, + "ADV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADV" + } + }, + "AUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUX" + } + }, + "CONJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONJ" + } + }, + "CCONJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CCONJ" + } + }, + "DET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DET" + } + }, + "INTJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTJ" + } + }, + "NOUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOUN" + } + }, + "NUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUM" + } + }, + "O": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "O" + } + }, + "PART": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PART" + } + }, + "PRON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRON" + } + }, + "PROPN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROPN" } - ] + }, + "PUNCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUNCT" + } + }, + "SCONJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCONJ" + } + }, + "SYM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYM" + } + }, + "VERB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERB" + } + } } }, "com.amazonaws.comprehend#PiiEntitiesDetectionJobFilter": { @@ -6476,233 +8669,309 @@ "traits": { "smithy.api#documentation": "

Specifies whether the output provides the locations (offsets) of PII entities or a file in\n which PII entities are redacted.

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

Provides information about a PII entities detection job.

" - } - }, - "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" - } - }, - "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MASK", - "name": "MASK" - }, - { - "value": "REPLACE_WITH_PII_ENTITY_TYPE", - "name": "REPLACE_WITH_PII_ENTITY_TYPE" + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a PII entities detection job.

" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode": { + "type": "enum", + "members": { + "MASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASK" + } + }, + "REPLACE_WITH_PII_ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_WITH_PII_ENTITY_TYPE" + } + } + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionMode": { + "type": "enum", + "members": { + "ONLY_REDACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLY_REDACTION" + } + }, + "ONLY_OFFSETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLY_OFFSETS" + } + } + } + }, + "com.amazonaws.comprehend#PiiEntity": { + "type": "structure", + "members": { + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

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

The entity's type.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n entity.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n entity.

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

Provides information about a PII entity.

" + } + }, + "com.amazonaws.comprehend#PiiEntityType": { + "type": "enum", + "members": { + "BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BANK_ACCOUNT_NUMBER" + } + }, + "BANK_ROUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BANK_ROUTING" + } + }, + "CREDIT_DEBIT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_NUMBER" + } + }, + "CREDIT_DEBIT_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CVV" + } + }, + "CREDIT_DEBIT_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_EXPIRY" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIN" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "SSN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSN" + } + }, + "DATE_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_TIME" + } + }, + "PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSPORT_NUMBER" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + }, + "IN_PERMANENT_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PERMANENT_ACCOUNT_NUMBER" + } + }, + "IN_NREGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_NREGA" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" } - ] - } - }, - "com.amazonaws.comprehend#PiiEntitiesDetectionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ONLY_REDACTION", - "name": "ONLY_REDACTION" - }, - { - "value": "ONLY_OFFSETS", - "name": "ONLY_OFFSETS" + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWIFT_CODE" } - ] - } - }, - "com.amazonaws.comprehend#PiiEntity": { - "type": "structure", - "members": { - "Score": { - "target": "com.amazonaws.comprehend#Float", + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" } }, - "Type": { - "target": "com.amazonaws.comprehend#PiiEntityType", + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The entity's type.

" + "smithy.api#enumValue": "CA_HEALTH_NUMBER" } }, - "BeginOffset": { - "target": "com.amazonaws.comprehend#Integer", + "IN_AADHAAR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n entity.

" + "smithy.api#enumValue": "IN_AADHAAR" } }, - "EndOffset": { - "target": "com.amazonaws.comprehend#Integer", + "IN_VOTER_NUMBER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n entity.

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

Provides information about a PII entity.

" - } - }, - "com.amazonaws.comprehend#PiiEntityType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BANK_ACCOUNT_NUMBER", - "name": "BANK_ACCOUNT_NUMBER" - }, - { - "value": "BANK_ROUTING", - "name": "BANK_ROUTING" - }, - { - "value": "CREDIT_DEBIT_NUMBER", - "name": "CREDIT_DEBIT_NUMBER" - }, - { - "value": "CREDIT_DEBIT_CVV", - "name": "CREDIT_DEBIT_CVV" - }, - { - "value": "CREDIT_DEBIT_EXPIRY", - "name": "CREDIT_DEBIT_EXPIRY" - }, - { - "value": "PIN", - "name": "PIN" - }, - { - "value": "EMAIL", - "name": "EMAIL" - }, - { - "value": "ADDRESS", - "name": "ADDRESS" - }, - { - "value": "NAME", - "name": "NAME" - }, - { - "value": "PHONE", - "name": "PHONE" - }, - { - "value": "SSN", - "name": "SSN" - }, - { - "value": "DATE_TIME", - "name": "DATE_TIME" - }, - { - "value": "PASSPORT_NUMBER", - "name": "PASSPORT_NUMBER" - }, - { - "value": "DRIVER_ID", - "name": "DRIVER_ID" - }, - { - "value": "URL", - "name": "URL" - }, - { - "value": "AGE", - "name": "AGE" - }, - { - "value": "USERNAME", - "name": "USERNAME" - }, - { - "value": "PASSWORD", - "name": "PASSWORD" - }, - { - "value": "AWS_ACCESS_KEY", - "name": "AWS_ACCESS_KEY" - }, - { - "value": "AWS_SECRET_KEY", - "name": "AWS_SECRET_KEY" - }, - { - "value": "IP_ADDRESS", - "name": "IP_ADDRESS" - }, - { - "value": "MAC_ADDRESS", - "name": "MAC_ADDRESS" - }, - { - "value": "ALL", - "name": "ALL" - }, - { - "value": "LICENSE_PLATE", - "name": "LICENSE_PLATE" - }, - { - "value": "VEHICLE_IDENTIFICATION_NUMBER", - "name": "VEHICLE_IDENTIFICATION_NUMBER" - }, - { - "value": "UK_NATIONAL_INSURANCE_NUMBER", - "name": "UK_NATIONAL_INSURANCE_NUMBER" - }, - { - "value": "CA_SOCIAL_INSURANCE_NUMBER", - "name": "CA_SOCIAL_INSURANCE_NUMBER" - }, - { - "value": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", - "name": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" - }, - { - "value": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", - "name": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" - }, - { - "value": "IN_PERMANENT_ACCOUNT_NUMBER", - "name": "IN_PERMANENT_ACCOUNT_NUMBER" - }, - { - "value": "IN_NREGA", - "name": "IN_NREGA" - }, - { - "value": "INTERNATIONAL_BANK_ACCOUNT_NUMBER", - "name": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" - }, - { - "value": "SWIFT_CODE", - "name": "SWIFT_CODE" - }, - { - "value": "UK_NATIONAL_HEALTH_SERVICE_NUMBER", - "name": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" - }, - { - "value": "CA_HEALTH_NUMBER", - "name": "CA_HEALTH_NUMBER" - }, - { - "value": "IN_AADHAAR", - "name": "IN_AADHAAR" - }, - { - "value": "IN_VOTER_NUMBER", - "name": "IN_VOTER_NUMBER" - } - ] } }, "com.amazonaws.comprehend#PiiOutputDataConfig": { @@ -6726,6 +8995,26 @@ "smithy.api#documentation": "

Provides configuration parameters for the output of PII entity detection jobs.

" } }, + "com.amazonaws.comprehend#Point": { + "type": "structure", + "members": { + "X": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The value of the X coordinate for a point on a polygon

" + } + }, + "Y": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The value of the Y coordinate for a point on a polygon

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

The X and Y coordinates of a point on a document page.

\n

For additional information, see Point in the Amazon Textract API reference.

" + } + }, "com.amazonaws.comprehend#Policy": { "type": "string", "traits": { @@ -6746,6 +9035,12 @@ "smithy.api#pattern": "^[0-9A-Fa-f]+$" } }, + "com.amazonaws.comprehend#Polygon": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Point" + } + }, "com.amazonaws.comprehend#PutResourcePolicy": { "type": "operation", "input": { @@ -6831,6 +9126,37 @@ "smithy.api#documentation": "

Provides configuration parameters for PII entity redaction.

" } }, + "com.amazonaws.comprehend#RelationshipType": { + "type": "enum", + "members": { + "CHILD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHILD" + } + } + } + }, + "com.amazonaws.comprehend#RelationshipsListItem": { + "type": "structure", + "members": { + "Ids": { + "target": "com.amazonaws.comprehend#StringList", + "traits": { + "smithy.api#documentation": "

Identifers of the child blocks.

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

Only supported relationship is a child relationship.

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

List of child blocks for the current block.

" + } + }, "com.amazonaws.comprehend#ResourceInUseException": { "type": "structure", "members": { @@ -6915,6 +9241,14 @@ } } }, + "com.amazonaws.comprehend#SemiStructuredDocumentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.comprehend#SentimentDetectionJobFilter": { "type": "structure", "members": { @@ -7072,41 +9406,49 @@ } }, "com.amazonaws.comprehend#SentimentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "POSITIVE", - "name": "POSITIVE" - }, - { - "value": "NEGATIVE", - "name": "NEGATIVE" - }, - { - "value": "NEUTRAL", - "name": "NEUTRAL" - }, - { - "value": "MIXED", - "name": "MIXED" + "type": "enum", + "members": { + "POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITIVE" + } + }, + "NEGATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEGATIVE" + } + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + }, + "MIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIXED" } - ] + } } }, "com.amazonaws.comprehend#Split": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRAIN", - "name": "TRAIN" - }, - { - "value": "TEST", - "name": "TEST" + "type": "enum", + "members": { + "TRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAIN" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST" } - ] + } } }, "com.amazonaws.comprehend#StartDocumentClassificationJob": { @@ -8611,6 +10953,12 @@ } } }, + "com.amazonaws.comprehend#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#String" + } + }, "com.amazonaws.comprehend#SubnetId": { "type": "string", "traits": { @@ -8634,34 +10982,44 @@ } }, "com.amazonaws.comprehend#SyntaxLanguageCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "en", - "name": "EN" - }, - { - "value": "es", - "name": "ES" - }, - { - "value": "fr", - "name": "FR" - }, - { - "value": "de", - "name": "DE" - }, - { - "value": "it", - "name": "IT" - }, - { - "value": "pt", - "name": "PT" + "type": "enum", + "members": { + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt" } - ] + } } }, "com.amazonaws.comprehend#SyntaxToken": { @@ -8952,78 +11310,110 @@ } }, "com.amazonaws.comprehend#TargetedSentimentEntityType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PERSON", - "name": "PERSON" - }, - { - "value": "LOCATION", - "name": "LOCATION" - }, - { - "value": "ORGANIZATION", - "name": "ORGANIZATION" - }, - { - "value": "FACILITY", - "name": "FACILITY" - }, - { - "value": "BRAND", - "name": "BRAND" - }, - { - "value": "COMMERCIAL_ITEM", - "name": "COMMERCIAL_ITEM" - }, - { - "value": "MOVIE", - "name": "MOVIE" - }, - { - "value": "MUSIC", - "name": "MUSIC" - }, - { - "value": "BOOK", - "name": "BOOK" - }, - { - "value": "SOFTWARE", - "name": "SOFTWARE" - }, - { - "value": "GAME", - "name": "GAME" - }, - { - "value": "PERSONAL_TITLE", - "name": "PERSONAL_TITLE" - }, - { - "value": "EVENT", - "name": "EVENT" - }, - { - "value": "DATE", - "name": "DATE" - }, - { - "value": "QUANTITY", - "name": "QUANTITY" - }, - { - "value": "ATTRIBUTE", - "name": "ATTRIBUTE" - }, - { - "value": "OTHER", - "name": "OTHER" + "type": "enum", + "members": { + "PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSON" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" + } + }, + "ORGANIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORGANIZATION" + } + }, + "FACILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACILITY" + } + }, + "BRAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BRAND" + } + }, + "COMMERCIAL_ITEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMERCIAL_ITEM" + } + }, + "MOVIE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOVIE" + } + }, + "MUSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUSIC" + } + }, + "BOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOK" + } + }, + "SOFTWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOFTWARE" + } + }, + "GAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GAME" + } + }, + "PERSONAL_TITLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSONAL_TITLE" } - ] + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "QUANTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUANTITY" + } + }, + "ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTRIBUTE" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } } }, "com.amazonaws.comprehend#TargetedSentimentMention": { diff --git a/codegen/sdk-codegen/aws-models/gamelift.json b/codegen/sdk-codegen/aws-models/gamelift.json index ee204561e10..ffa26d4c8b7 100644 --- a/codegen/sdk-codegen/aws-models/gamelift.json +++ b/codegen/sdk-codegen/aws-models/gamelift.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -52,7 +52,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a player's acceptance or rejection of a proposed FlexMatch match. A\n matchmaking configuration may require player acceptance; if so, then matches built with\n that configuration cannot be completed unless all players accept the proposed match\n within a specified time limit.

\n

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed\n match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for\n your game to get acceptance from all players in the ticket. Acceptances are only valid\n for tickets when they are in this status; all other acceptances result in an\n error.

\n

To register acceptance, specify the ticket ID, a response, and one or more players.\n Once all players have registered acceptance, the matchmaking tickets advance to status\n PLACING, where a new game session is created for the match.

\n

If any player rejects the match, or if acceptances are not received before a specified\n timeout, the proposed match is dropped. The matchmaking tickets are then handled in one\n of two ways: For tickets where one or more players rejected the match or failed to\n respond, the ticket status is set to CANCELLED, and processing is\n terminated. For tickets where players have accepted or not yet responded, the ticket\n status is returned to SEARCHING to find a new match. A new matchmaking\n request for these players can be submitted as needed.

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n FlexMatch events (reference)

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" + "smithy.api#documentation": "

Registers a player's acceptance or rejection of a proposed FlexMatch match. A\n matchmaking configuration may require player acceptance; if so, then matches built with\n that configuration cannot be completed unless all players accept the proposed match\n within a specified time limit.

\n

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed\n match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for\n your game to get acceptance from all players in the ticket. Acceptances are only valid\n for tickets when they are in this status; all other acceptances result in an\n error.

\n

To register acceptance, specify the ticket ID, a response, and one or more players.\n Once all players have registered acceptance, the matchmaking tickets advance to status\n PLACING, where a new game session is created for the match.

\n

If any player rejects the match, or if acceptances are not received before a specified\n timeout, the proposed match is dropped. The matchmaking tickets are then handled in one\n of two ways: For tickets where one or more players rejected the match or failed to\n respond, the ticket status is set to CANCELLED, and processing is\n terminated. For tickets where players have accepted or not yet responded, the ticket\n status is returned to SEARCHING to find a new match. A new matchmaking\n request for these players can be submitted as needed.

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n \n FlexMatch events (reference)

" } }, "com.amazonaws.gamelift#AcceptMatchInput": { @@ -68,7 +68,7 @@ "PlayerIds": { "target": "com.amazonaws.gamelift#StringList", "traits": { - "smithy.api#documentation": "

A unique identifier for a player delivering the response. This parameter can include one or multiple\n player IDs.

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

A unique identifier for a player delivering the response. This parameter can include one or multiple player\n IDs.

", "smithy.api#required": {} } }, @@ -79,9 +79,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#AcceptMatchOutput": { @@ -89,18 +86,20 @@ "members": {} }, "com.amazonaws.gamelift#AcceptanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACCEPT", - "name": "ACCEPT" - }, - { - "value": "REJECT", - "name": "REJECT" + "type": "enum", + "members": { + "ACCEPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECT" } - ] + } } }, "com.amazonaws.gamelift#Alias": { @@ -133,7 +132,7 @@ "RoutingStrategy": { "target": "com.amazonaws.gamelift#RoutingStrategy", "traits": { - "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the alias.

" + "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the alias.\n

" } }, "CreationTime": { @@ -150,7 +149,7 @@ } }, "traits": { - "smithy.api#documentation": "

Properties that describe an alias resource.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

Properties that describe an alias resource.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#AliasArn": { @@ -186,6 +185,21 @@ } } }, + "com.amazonaws.gamelift#AnywhereConfiguration": { + "type": "structure", + "members": { + "Cost": { + "target": "com.amazonaws.gamelift#NonNegativeLimitedLengthDouble", + "traits": { + "smithy.api#documentation": "

The cost to run your fleet per hour. GameLift uses the provided cost of your fleet to balance\n usage in queues. For more information about queues, see Setting up\n queues.

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

GameLift Anywhere configuration options for your Anywhere fleets.

" + } + }, "com.amazonaws.gamelift#ArnStringModel": { "type": "string", "traits": { @@ -200,7 +214,7 @@ "type": "structure", "members": { "S": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "target": "com.amazonaws.gamelift#PlayerAttributeString", "traits": { "smithy.api#documentation": "

For single string values. Maximum string length is 100 characters.

" } @@ -212,20 +226,20 @@ } }, "SL": { - "target": "com.amazonaws.gamelift#StringList", + "target": "com.amazonaws.gamelift#PlayerAttributeStringList", "traits": { "smithy.api#documentation": "

For a list of up to 100 strings. Maximum length for each string is 100 characters.\n Duplicate values are not recognized; all occurrences of the repeated value after the\n first of a repeated value are ignored.

" } }, "SDM": { - "target": "com.amazonaws.gamelift#StringDoubleMap", + "target": "com.amazonaws.gamelift#PlayerAttributeStringDoubleMap", "traits": { - "smithy.api#documentation": "

For a map of up to 10 data type:value pairs. Maximum length for each string value\n is 100 characters.

" + "smithy.api#documentation": "

For a map of up to 10 data type:value pairs. Maximum length for each string value is\n 100 characters.

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

Values for use in Player attribute key-value pairs. This object lets\n you specify an attribute value using any of the valid data types: string, number, string\n array, or data map. Each AttributeValue object can use only one of the\n available properties.

" + "smithy.api#documentation": "

Values for use in player attribute key-value pairs. This object lets\n you specify an attribute value using any of the valid data types: string, number, string\n array, or data map. Each AttributeValue object can use only one of the\n available properties.

" } }, "com.amazonaws.gamelift#AutoScalingGroupArn": { @@ -261,49 +275,52 @@ } }, "traits": { - "smithy.api#documentation": "

Temporary access credentials used for uploading game build files to Amazon GameLift. They\n are valid for a limited time. If they expire before you upload your game build, get a\n new set by calling RequestUploadCredentials.

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

Temporary access credentials used for uploading game build files to Amazon GameLift. They are\n valid for a limited time. If they expire before you upload your game build, get a new\n set by calling RequestUploadCredentials.

", "smithy.api#sensitive": {} } }, "com.amazonaws.gamelift#BackfillMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTOMATIC", - "name": "AUTOMATIC" - }, - { - "value": "MANUAL", - "name": "MANUAL" + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" } - ] + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } } }, "com.amazonaws.gamelift#BalancingStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SPOT_ONLY", - "name": "SPOT_ONLY" - }, - { - "value": "SPOT_PREFERRED", - "name": "SPOT_PREFERRED" - }, - { - "value": "ON_DEMAND_ONLY", - "name": "ON_DEMAND_ONLY" + "type": "enum", + "members": { + "SPOT_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT_ONLY" + } + }, + "SPOT_PREFERRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT_PREFERRED" + } + }, + "ON_DEMAND_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND_ONLY" } - ] + } } }, "com.amazonaws.gamelift#BooleanModel": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.gamelift#Build": { "type": "structure", @@ -317,19 +334,19 @@ "BuildArn": { "target": "com.amazonaws.gamelift#BuildArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the\n BuildId value.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the\n BuildId value.

" } }, "Name": { "target": "com.amazonaws.gamelift#FreeText", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

" + "smithy.api#documentation": "

A descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or\n UpdateBuild.

" } }, "Version": { "target": "com.amazonaws.gamelift#FreeText", "traits": { - "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

" + "smithy.api#documentation": "

Version information associated with a build or script. Version strings do not need to be unique.

" } }, "Status": { @@ -341,7 +358,7 @@ "SizeOnDisk": { "target": "com.amazonaws.gamelift#PositiveLong", "traits": { - "smithy.api#documentation": "

File size of the uploaded game build, expressed in bytes. When the build status is\n INITIALIZED or when using a custom Amazon S3 storage location, \n this value is 0.

" + "smithy.api#documentation": "

File size of the uploaded game build, expressed in bytes. When the build status is\n INITIALIZED or when using a custom Amazon S3 storage location, this value is\n 0.

" } }, "OperatingSystem": { @@ -355,10 +372,16 @@ "traits": { "smithy.api#documentation": "

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } + }, + "ServerSdkVersion": { + "target": "com.amazonaws.gamelift#ServerSdkVersion", + "traits": { + "smithy.api#documentation": "

The GameLift Server SDK version used to develop your game server.

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

Properties describing a custom game build.

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Properties describing a custom game build.

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#BuildArn": { @@ -386,22 +409,26 @@ } }, "com.amazonaws.gamelift#BuildStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INITIALIZED", - "name": "INITIALIZED" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "INITIALIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZED" } - ] + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.gamelift#CertificateConfiguration": { @@ -416,22 +443,24 @@ } }, "traits": { - "smithy.api#documentation": "

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be\n enabled when creating the fleet. All instances in a fleet share the same\n certificate. The certificate can be retrieved by calling the\n GameLift Server\n SDK operation GetInstanceCertificate.

\n

A fleet's certificate configuration is part of FleetAttributes.

" + "smithy.api#documentation": "

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must\n be enabled when creating the fleet. All instances in a fleet share the same certificate.\n The certificate can be retrieved by calling the GameLift Server\n SDK operation GetInstanceCertificate.

" } }, "com.amazonaws.gamelift#CertificateType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DISABLED", - "name": "Disabled" - }, - { - "value": "GENERATED", - "name": "Generated" + "type": "enum", + "members": { + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + }, + "Generated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATED" + } + } } }, "com.amazonaws.gamelift#ClaimGameServer": { @@ -463,7 +492,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Locates an available game server and temporarily reserves it to host gameplay and\n players. This operation is called from a game client or client service (such as a\n matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ\n locates an available game server, places it in CLAIMED status for 60\n seconds, and returns connection information that players can use to connect to the game\n server.

\n

To claim a game server, identify a game server group. You can also specify a game\n server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally,\n include game data to pass to the game server at the start of a game session, such as a\n game map or player information.

\n

When a game server is successfully claimed, connection information is returned. A\n claimed game server's utilization status remains AVAILABLE while the claim\n status is set to CLAIMED for up to 60 seconds. This time period gives the\n game server time to update its status to UTILIZED (using UpdateGameServer) once players join. If the game server's status is not\n updated within 60 seconds, the game server reverts to unclaimed status and is available\n to be claimed by another request. The claim time period is a fixed value and is not\n configurable.

\n

If you try to claim a specific game server, this request will fail in the following\n cases:

\n \n \n

When claiming a specific game server, this request will succeed even if the game\n server is running on an instance in DRAINING status. To avoid this,\n first check the instance status by calling DescribeGameServerInstances.

\n \n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Locates an available game server and\n temporarily reserves it to host gameplay and players. This operation is called from a\n game client or client service (such as a matchmaker) to request hosting resources for a\n new game session. In response, GameLift FleetIQ locates an available game server, places it in\n CLAIMED status for 60 seconds, and returns connection information that\n players can use to connect to the game server.

\n

To claim a game server, identify a game server group. You can also specify a game\n server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally,\n include game data to pass to the game server at the start of a game session, such as a\n game map or player information.

\n

When a game server is successfully claimed, connection information is returned. A\n claimed game server's utilization status remains AVAILABLE while the claim\n status is set to CLAIMED for up to 60 seconds. This time period gives the\n game server time to update its status to UTILIZED after players join. If\n the game server's status is not updated within 60 seconds, the game server reverts to\n unclaimed status and is available to be claimed by another request. The claim time\n period is a fixed value and is not configurable.

\n

If you try to claim a specific game server, this request will fail in the following\n cases:

\n \n \n

When claiming a specific game server, this request will succeed even if the game\n server is running on an instance in DRAINING status. To avoid this,\n first check the instance status by calling DescribeGameServerInstances .

\n \n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#ClaimGameServerInput": { @@ -472,20 +501,20 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value. If you are not specifying a game server to claim, this value identifies\n where you want GameLift FleetIQ to look for an available game server to claim.

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

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies\n where you want GameLift FleetIQ to look for an available game server to claim.

", "smithy.api#required": {} } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { - "smithy.api#documentation": "

A custom string that uniquely identifies the game server to claim. If this parameter\n is left empty, GameLift FleetIQ searches for an available game server in the specified game\n server group.

" + "smithy.api#documentation": "

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available\n game server in the specified game server group.

" } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers.

" } } } @@ -502,26 +531,198 @@ } }, "com.amazonaws.gamelift#ComparisonOperatorType": { + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } + } + }, + "com.amazonaws.gamelift#Compute": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet that the compute is registered to.

" + } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet that the compute is registered to.

" + } + }, + "ComputeName": { + "target": "com.amazonaws.gamelift#ComputeName", + "traits": { + "smithy.api#documentation": "

A descriptive label that is associated with the compute resource registered to your fleet.

" + } + }, + "ComputeArn": { + "target": "com.amazonaws.gamelift#ComputeArn", + "traits": { + "smithy.api#documentation": "

The ARN that is assigned to the compute resource and uniquely identifies it. ARNs are\n unique across locations.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.gamelift#IpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the compute resource. GameLift requires the DNS name or IP address to\n manage your compute resource.

" + } + }, + "DnsName": { + "target": "com.amazonaws.gamelift#DnsName", + "traits": { + "smithy.api#documentation": "

The DNS name of the compute resource. GameLift requires the DNS name or IP address to\n manage your compute resource.

" + } + }, + "ComputeStatus": { + "target": "com.amazonaws.gamelift#ComputeStatus", + "traits": { + "smithy.api#documentation": "

Current status of the compute. A compute must have an ACTIVE status to host game sessions.

" + } + }, + "Location": { + "target": "com.amazonaws.gamelift#LocationStringModel", + "traits": { + "smithy.api#documentation": "

The name of the custom location you added to the fleet that this compute resource\n resides in.

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

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } + }, + "OperatingSystem": { + "target": "com.amazonaws.gamelift#OperatingSystem", + "traits": { + "smithy.api#documentation": "

The type of operating system on your compute resource.

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

Which compute type that the fleet uses. A fleet can use Anywhere compute resources\n owned by you or managed Amazon EC2 instances.

" + } + }, + "GameLiftServiceSdkEndpoint": { + "target": "com.amazonaws.gamelift#GameLiftServiceSdkEndpointOutput", + "traits": { + "smithy.api#documentation": "

The endpoint connection details of the GameLift SDK endpoint that your game server\n connects to.

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

Resources used to host your game servers. A compute resource can be managed GameLift\n Amazon EC2 instances or your own resources.

" + } + }, + "com.amazonaws.gamelift#ComputeArn": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "GreaterThanOrEqualToThreshold", - "name": "GreaterThanOrEqualToThreshold" - }, - { - "value": "GreaterThanThreshold", - "name": "GreaterThanThreshold" - }, - { - "value": "LessThanThreshold", - "name": "LessThanThreshold" - }, - { - "value": "LessThanOrEqualToThreshold", - "name": "LessThanOrEqualToThreshold" + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:.*:compute\\/[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#ComputeAuthToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#ComputeList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#Compute" + } + }, + "com.amazonaws.gamelift#ComputeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#ComputeNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+|^arn:.*:compute\\/[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#ComputeStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + } + } + }, + "com.amazonaws.gamelift#ComputeType": { + "type": "enum", + "members": { + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" } - ] + }, + "ANYWHERE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANYWHERE" + } + } } }, "com.amazonaws.gamelift#ConflictException": { @@ -532,7 +733,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.

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

The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.

\n

", "smithy.api#error": "client" } }, @@ -565,7 +766,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an alias for a fleet. In most situations, you can use an alias ID in place of\n a fleet ID. An alias provides a level of abstraction for a fleet that is useful when\n redirecting player traffic from one fleet to another, such as when updating your game\n build.

\n

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A\n simple alias points to an active fleet. A terminal alias is used to display messaging or\n link to a URL instead of routing players to an active fleet. For example, you might use\n a terminal alias when a game version is no longer supported and you want to direct\n players to an upgrade site.

\n

To create a fleet alias, specify an alias name, routing strategy, and optional\n description. Each simple alias can point to only one fleet, but a fleet can have\n multiple aliases. If successful, a new alias record is returned, including an alias ID\n and an ARN. You can reassign an alias to another fleet by calling\n UpdateAlias.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates an alias for a fleet. In most situations, you can use an alias ID in place of\n a fleet ID. An alias provides a level of abstraction for a fleet that is useful when\n redirecting player traffic from one fleet to another, such as when updating your game\n build.

\n

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A\n simple alias points to an active fleet. A terminal alias is used to display messaging or\n link to a URL instead of routing players to an active fleet. For example, you might use\n a terminal alias when a game version is no longer supported and you want to direct\n players to an upgrade site.

\n

To create a fleet alias, specify an alias name, routing strategy, and optional\n description. Each simple alias can point to only one fleet, but a fleet can have\n multiple aliases. If successful, a new alias record is returned, including an alias ID\n and an ARN. You can reassign an alias to another fleet by calling\n UpdateAlias.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateAliasInput": { @@ -587,19 +788,16 @@ "RoutingStrategy": { "target": "com.amazonaws.gamelift#RoutingStrategy", "traits": { - "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the alias.

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

The routing configuration, including routing type and fleet target, for the alias.\n

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

A list of labels to assign to the new alias resource. Tags are developer-defined \n key-value pairs. Tagging\n Amazon Web Services resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new alias resource. Tags are developer-defined\n key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access\n management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateAliasOutput": { @@ -611,9 +809,6 @@ "smithy.api#documentation": "

The newly created alias resource.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateBuild": { @@ -642,7 +837,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon GameLift build resource for your game server binary files. Game server\n binaries must be combined into a zip file for use with Amazon GameLift.

\n \n

When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI\n command \n upload-build\n . This helper command combines two tasks: (1) it\n uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)\n it creates a new build resource.

\n \n

The CreateBuild operation can used in the following scenarios:

\n \n

If successful, this operation creates a new build resource with a unique build ID and\n places it in INITIALIZED status. A build must be in READY\n status before you can create fleets with it.

\n

\n Learn more\n

\n

\n Uploading Your\n Game\n

\n

\n Create a Build with Files in Amazon S3\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a new Amazon GameLift build resource for your game server binary files. Combine game\n server binaries into a zip file for use with Amazon GameLift.

\n \n

When setting up a new game build for GameLift, we recommend using the CLI command \n upload-build\n . This helper command combines two tasks: (1) it\n uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)\n it creates a new build resource.

\n \n

You can use the operation in the following scenarios:

\n \n

If successful, this operation creates a new build resource with a unique build ID and\n places it in INITIALIZED status. A build must be in READY\n status before you can create fleets with it.

\n

\n Learn more\n

\n

\n Uploading Your\n Game\n

\n

\n Create a Build with Files in Amazon S3\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateBuildInput": { @@ -651,36 +846,39 @@ "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.\n

" + "smithy.api#documentation": "

A descriptive label associated with a build. Build names do not need to be unique. You can change this value later.

" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later.\n

" + "smithy.api#documentation": "

Version information associated with a build or script. Version strings do not need to be unique. You can change this value later.

" } }, "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { - "smithy.api#documentation": "

Information indicating where your game build files are stored. Use this parameter only\n when creating a build with files stored in an Amazon S3 bucket that you own. The storage\n location must specify an Amazon S3 bucket name and key. The location must also specify a role\n ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your\n new build must be in the same Region.

\n

If a StorageLocation is specified, the size of your file\n can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0. \n

" + "smithy.api#documentation": "

Information indicating where your game build files are stored. Use this parameter only\n when creating a build with files stored in an Amazon S3 bucket that you own. The storage\n location must specify an Amazon S3 bucket name and key. The location must also specify a role\n ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your\n new build must be in the same Region.

\n

If a StorageLocation is specified, the size of your file can be found in\n your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.

" } }, "OperatingSystem": { "target": "com.amazonaws.gamelift#OperatingSystem", "traits": { - "smithy.api#documentation": "

The operating system that the game server binaries are built to run on. This value\n determines the type of fleet resources that you can use for this build. If your game\n build contains multiple executables, they all must run on the same operating system. If\n an operating system is not specified when creating a build, Amazon GameLift uses the\n default value (WINDOWS_2012). This value cannot be changed later.

" + "smithy.api#documentation": "

The operating system that you built the game server binaries to run on. This value\n determines the type of fleet resources that you can use for this build. If your game\n build contains multiple executables, they all must run on the same operating system. If\n an operating system is not specified when creating a build, GameLift uses the\n default value (WINDOWS_2012). This value cannot be changed later.

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

A list of labels to assign to the new build resource. Tags are developer-defined \n key-value pairs. Tagging\n Amazon Web Services resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new build resource. Tags are developer defined\n key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access\n management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and\n ListTagsForResource to add, remove, and view tags. The maximum tag limit\n may be lower than stated. See the Amazon Web Services General Reference for actual tagging\n limits.

" + } + }, + "ServerSdkVersion": { + "target": "com.amazonaws.gamelift#ServerSdkVersion", + "traits": { + "smithy.api#documentation": "

A server SDK version you used when integrating your game server build with GameLift. For more information see Integrate games\n with custom game servers.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateBuildOutput": { @@ -695,18 +893,15 @@ "UploadCredentials": { "target": "com.amazonaws.gamelift#AwsCredentials", "traits": { - "smithy.api#documentation": "

This element is returned only when the operation is called without a storage\n location. It contains credentials to use when you are uploading a build file to an Amazon S3\n bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these\n credentials, call RequestUploadCredentials.

" + "smithy.api#documentation": "

This element is returned only when the operation is called without a storage location.\n It contains credentials to use when you are uploading a build file to an Amazon S3 bucket\n that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these\n credentials, call RequestUploadCredentials.

" } }, "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { - "smithy.api#documentation": "

Amazon S3 location for your game build file, including bucket name and\n key.

" + "smithy.api#documentation": "

Amazon S3 location for your game build file, including bucket name and key.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateFleet": { @@ -744,7 +939,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your\n custom game server or Realtime Servers. Use this operation to configure the computing resources for\n your fleet and provide instructions for running game servers on each instance.

\n

Most GameLift fleets can deploy instances to multiple locations, including the home\n Region (where the fleet is created) and an optional set of remote locations. Fleets that\n are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N.\n Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),\n ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that\n are created in other GameLift Regions can deploy instances in the fleet's home Region\n only. All fleet instances use the same configuration regardless of location; however,\n you can adjust capacity settings and turn auto-scaling on/off for each location.

\n

To create a fleet, choose the hardware for your instances, specify a game server build\n or Realtime script to deploy, and provide a runtime configuration to direct GameLift how\n to start and run game servers on each instance in the fleet. Set permissions for inbound\n traffic to your game servers, and enable optional features as needed. When creating a\n multi-location fleet, provide a list of additional remote locations.

\n

If you need to debug your fleet, fetch logs, view performance metrics\n or other actions on the fleet, create the development fleet with port 22/3389 open.\n As a best practice, we recommend opening ports for remote access only when you need them \n and closing them when you're finished.

\n

If successful, this operation creates a new Fleet resource and places it in\n NEW status, which prompts GameLift to initiate the fleet creation\n workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events\n using DescribeFleetEvents. As soon as the fleet status changes to\n ACTIVE, you can enable automatic scaling for the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches\n ACTIVE, you can set capacity by location using UpdateFleetCapacity.

\n\n \n

\n Learn more\n

\n

\n Setting up fleets\n

\n

\n Debug fleet creation issues\n

\n

\n Multi-location fleets\n

\n

\n Related actions\n

\n

\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your\n custom game server or Realtime Servers. Use this operation to configure the computing resources for\n your fleet and provide instructions for running game servers on each instance.

\n

Most GameLift fleets can deploy instances to multiple locations, including the home\n Region (where the fleet is created) and an optional set of remote locations. Fleets that\n are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N.\n Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),\n ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that\n are created in other GameLift Regions can deploy instances in the fleet's home Region\n only. All fleet instances use the same configuration regardless of location; however,\n you can adjust capacity settings and turn auto-scaling on/off for each location.

\n

To create a fleet, choose the hardware for your instances, specify a game server build\n or Realtime script to deploy, and provide a runtime configuration to direct GameLift how\n to start and run game servers on each instance in the fleet. Set permissions for inbound\n traffic to your game servers, and enable optional features as needed. When creating a\n multi-location fleet, provide a list of additional remote locations.

\n

If you need to debug your fleet, fetch logs, view performance metrics or other actions\n on the fleet, create the development fleet with port 22/3389 open. As a best practice,\n we recommend opening ports for remote access only when you need them and closing them\n when you're finished.

\n

If successful, this operation creates a new Fleet resource and places it in\n NEW status, which prompts GameLift to initiate the fleet creation\n workflow.

\n

\n Learn more\n

\n

\n Setting up\n fleets\n

\n

\n Debug fleet creation issues\n

\n

\n Multi-location fleets\n

" } }, "com.amazonaws.gamelift#CreateFleetInput": { @@ -760,7 +955,7 @@ "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A human-readable description of the fleet.

" + "smithy.api#documentation": "

A description for the fleet.

" } }, "BuildId": { @@ -790,14 +985,13 @@ "LogPaths": { "target": "com.amazonaws.gamelift#StringList", "traits": { - "smithy.api#documentation": "

\n This parameter is no longer used. To specify where\n GameLift should store log files once a server process shuts down, use the GameLift server\n API ProcessReady() and specify one or more directory paths in\n logParameters. See more information in the Server API Reference.

" + "smithy.api#documentation": "

\n This parameter is no longer used. To specify where\n GameLift should store log files once a server process shuts down, use the GameLift server\n API ProcessReady() and specify one or more directory paths in\n logParameters. For more information, see Initialize the server process in the GameLift Developer\n Guide.

" } }, "EC2InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "

The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance\n type determines the computing resources that will be used to host your game servers,\n including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions\n of Amazon EC2 instance types.

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

The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance\n type determines the computing resources that will be used to host your game servers,\n including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions\n of Amazon EC2 instance types.

" } }, "EC2InboundPermissions": { @@ -809,7 +1003,7 @@ "NewGameSessionProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "

The status of termination protection for active game sessions on the fleet. By\n default, this property is set to NoProtection. You can also set game\n session protection for an individual game session by calling UpdateGameSession.

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

The status of termination protection for active game sessions on the fleet. By\n default, this property is set to NoProtection. You can also set game\n session protection for an individual game session by calling UpdateGameSession.

\n " } }, "RuntimeConfiguration": { @@ -839,7 +1033,7 @@ "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the Amazon Web Services Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.

" + "smithy.api#documentation": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the Amazon Web Services Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.

" } }, "FleetType": { @@ -851,30 +1045,39 @@ "InstanceRoleArn": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

A unique identifier for an IAM role that manages access to your Amazon Web Services services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN by using the IAM dashboard in the Amazon Web Services Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server. This property cannot be changed after the fleet is created.

" + "smithy.api#documentation": "

A unique identifier for an IAM role that manages access to your Amazon Web Services services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN by using the IAM dashboard in the Amazon Web Services Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server. This property cannot be changed after the fleet is created.

" } }, "CertificateConfiguration": { "target": "com.amazonaws.gamelift#CertificateConfiguration", "traits": { - "smithy.api#documentation": "

Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are\n used for encrypting traffic between game clients and the game servers that are running\n on GameLift. By default, the CertificateConfiguration is set to\n DISABLED. This property cannot be changed after the fleet is created.

\n

Note: This feature requires the Amazon Web Services Certificate Manager (ACM) service, which is not\n available in all Amazon Web Services regions. When working in a region that does not support this\n feature, a fleet creation request with certificate generation fails with a 4xx\n error.

" + "smithy.api#documentation": "

Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the\n certificates to encrypt traffic between game clients and the game servers running on\n GameLift. By default, the CertificateConfiguration is DISABLED.\n You can't change this property after you create the fleet.

\n

Certificate Manager (ACM) certificates expire after 13 months.\n Certificate expiration can cause fleets to fail, preventing players from connecting to\n instances in the fleet. We recommend you replace fleets before 13 months, consider using\n fleet aliases for a smooth transition.

\n \n

ACM isn't available in all Amazon Web Services regions. A fleet creation request\n with certificate generation enabled in an unsupported Region, fails with a 4xx\n error. For more information about the supported Regions, see Supported\n Regions in the Certificate Manager User\n Guide.

\n " } }, "Locations": { "target": "com.amazonaws.gamelift#LocationConfigurationList", "traits": { - "smithy.api#documentation": "

A set of remote locations to deploy additional instances to and manage as part of the\n fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support\n multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote location,\n in the form of an Amazon Web Services Region code such as us-west-2. To create a fleet with\n instances in the home Region only, omit this parameter.

" + "smithy.api#documentation": "

A set of remote locations to deploy additional instances to and manage as part of the\n fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that\n support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote\n location, in the form of an Amazon Web Services Region code such as us-west-2. To create\n a fleet with instances in the home Region only, omit this parameter.

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

A list of labels to assign to the new fleet resource. Tags are developer-defined\n key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access\n management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the fleet is created, you can use\n TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit\n may be lower than stated. See the Amazon Web Services General Reference for actual\n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new fleet resource. Tags are developer-defined\n key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access\n management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference.

" + } + }, + "ComputeType": { + "target": "com.amazonaws.gamelift#ComputeType", + "traits": { + "smithy.api#documentation": "

The type of compute resource used to host your game servers. You can use your own\n compute resources with GameLift Anywhere or use Amazon EC2 instances with managed\n GameLift.

" + } + }, + "AnywhereConfiguration": { + "target": "com.amazonaws.gamelift#AnywhereConfiguration", + "traits": { + "smithy.api#documentation": "

GameLift Anywhere configuration options.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateFleetLocations": { @@ -886,6 +1089,9 @@ "target": "com.amazonaws.gamelift#CreateFleetLocationsOutput" }, "errors": [ + { + "target": "com.amazonaws.gamelift#ConflictException" + }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, @@ -906,7 +1112,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds remote locations to a fleet and begins populating the new locations with EC2\n instances. The new instances conform to the fleet's instance type, auto-scaling, and\n other configuration settings.

\n \n

This operation cannot be used with fleets that don't support remote locations. Fleets\n can have multiple locations only if they reside in Amazon Web Services Regions that support this\n feature (see CreateFleet for the complete list) and were created\n after the feature was released in March 2021.

\n \n

To add fleet locations, specify the fleet to be updated and provide a list of one or\n more locations.

\n

If successful, this operation returns the list of added locations with their status set\n to NEW. GameLift initiates the process of starting an instance in each added\n location. You can track the status of each new location by monitoring location creation\n events using DescribeFleetEvents. Alternatively, you can poll location\n status by calling DescribeFleetLocationAttributes. After a location\n status becomes ACTIVE, you can adjust the location's capacity as needed\n with UpdateFleetCapacity.

\n

\n Learn more\n

\n

\n Setting up fleets\n

\n

\n Multi-location fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n

" + "smithy.api#documentation": "

Adds remote locations to a fleet and begins populating the new locations with EC2\n instances. The new instances conform to the fleet's instance type, auto-scaling, and\n other configuration settings.

\n \n

This operation cannot be used with fleets that don't support remote locations.\n Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support\n this feature and were created after the feature was released in March 2021.

\n \n

To add fleet locations, specify the fleet to be updated and provide a list of one or\n more locations.

\n

If successful, this operation returns the list of added locations with their status\n set to NEW. GameLift initiates the process of starting an instance in each\n added location. You can track the status of each new location by monitoring location\n creation events using DescribeFleetEvents.

\n

\n Learn more\n

\n

\n Setting up\n fleets\n

\n

\n Multi-location fleets\n

" } }, "com.amazonaws.gamelift#CreateFleetLocationsInput": { @@ -922,13 +1128,10 @@ "Locations": { "target": "com.amazonaws.gamelift#LocationConfigurationList", "traits": { - "smithy.api#documentation": "

A list of locations to deploy additional instances to and manage as part of the fleet.\n You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services\n Region code such as us-west-2.

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

A list of locations to deploy additional instances to and manage as part of the fleet.\n You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an\n Amazon Web Services Region code such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateFleetLocationsOutput": { @@ -949,12 +1152,9 @@ "LocationStates": { "target": "com.amazonaws.gamelift#LocationStateList", "traits": { - "smithy.api#documentation": "

The remote locations that are being added to the fleet, and the life-cycle status of each location. \n For new locations, the status is set to NEW.\n During location creation, GameLift updates each location's status as instances \n are deployed there and prepared for game hosting.\n This list does not include the fleet home Region or any remote locations that were already \n added to the fleet.

" + "smithy.api#documentation": "

The remote locations that are being added to the fleet, and the life-cycle status of\n each location. For new locations, the status is set to NEW. During location\n creation, GameLift updates each location's status as instances are deployed there and\n prepared for game hosting. This list does not include the fleet home Region or any\n remote locations that were already added to the fleet.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateFleetOutput": { @@ -972,9 +1172,6 @@ "smithy.api#documentation": "

The fleet's locations and life-cycle status of each location. For new fleets, the\n status of all locations is set to NEW. During fleet creation, GameLift\n updates each location status as instances are deployed there and prepared for game\n hosting. This list includes an entry for the fleet's home Region. For fleets with no\n remote locations, only one entry, representing the home Region, is returned.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateGameServerGroup": { @@ -1003,7 +1200,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Creates a GameLift FleetIQ game server group for managing game hosting on a collection of\n Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group,\n creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the\n two groups. You can view the status of your game server groups in the GameLift console.\n Game server group metrics and events are emitted to Amazon CloudWatch.

\n

Before creating a new game server group, you must have the following:

\n \n

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud\n launch template, and provide a list of instance types that can be used in the group. You\n must also set initial maximum and minimum limits on the group's instance count. You can\n optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ\n metric.

\n

Once the game server group and corresponding Auto Scaling group are created, you have\n full access to change the Auto Scaling group's configuration as needed. Several\n properties that are set when creating a game server group, including maximum/minimum\n size and auto-scaling policy settings, must be updated directly in the Auto Scaling\n group. Keep in mind that some Auto Scaling group properties are periodically updated by\n GameLift FleetIQ as part of its balancing activities to optimize for availability and\n cost.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n \n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Creates a GameLift FleetIQ game server\n group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting.\n This operation creates the game server group, creates an Auto Scaling group in your\n Amazon Web Services account, and establishes a link between the two groups. You can view the status of\n your game server groups in the GameLift console. Game server group metrics and events are\n emitted to Amazon CloudWatch.

\n

Before creating a new game server group, you must have the following:

\n \n

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud\n launch template, and provide a list of instance types that can be used in the group. You\n must also set initial maximum and minimum limits on the group's instance count. You can\n optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ\n metric.

\n

Once the game server group and corresponding Auto Scaling group are created, you have\n full access to change the Auto Scaling group's configuration as needed. Several\n properties that are set when creating a game server group, including maximum/minimum\n size and auto-scaling policy settings, must be updated directly in the Auto Scaling\n group. Keep in mind that some Auto Scaling group properties are periodically updated by\n GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#CreateGameServerGroupInput": { @@ -1040,7 +1237,7 @@ "LaunchTemplate": { "target": "com.amazonaws.gamelift#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The Amazon EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in the game server group. You can specify the template\n using either the template name or ID. For help with creating a launch template, see\n Creating a Launch\n Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling\n User Guide. After the Auto Scaling group is created, update this value\n directly in the Auto Scaling group using the Amazon Web Services console or APIs.

\n \n

If you specify network interfaces in your launch template, you must explicitly set\n the property AssociatePublicIpAddress to \"true\". If no network\n interface is specified in the launch template, GameLift FleetIQ uses your account's default\n VPC.

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

The Amazon EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in the game server group. You can specify the template\n using either the template name or ID. For help with creating a launch template, see\n Creating a Launch\n Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling\n User Guide. After the Auto Scaling group is created, update this value\n directly in the Auto Scaling group using the Amazon Web Services console or APIs.

\n \n

If you specify network interfaces in your launch template, you must explicitly set\n the property AssociatePublicIpAddress to \"true\". If no network\n interface is specified in the launch template, GameLift FleetIQ uses your account's default\n VPC.

\n ", "smithy.api#required": {} } }, @@ -1078,7 +1275,7 @@ "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new game server group resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource\n management, access management, and cost allocation. For more information, see Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference. Once the\n resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove,\n and view tags, respectively. The maximum tag limit may be lower than stated. See the\n Amazon Web Services General Reference for actual tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new game server group resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource\n management, access management, and cost allocation. For more information, see Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference.

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

Creates a multiplayer game session for players in a specific fleet location. This\n operation prompts an available server process to start a game session and retrieves\n connection information for the new game session. As an alternative, consider using the\n GameLift game session placement feature with

\n

with StartGameSessionPlacement, which uses FleetIQ algorithms and\n queues to optimize the placement process.

\n

When creating a game session, you specify exactly where you want to place it and\n provide a set of game session configuration settings. The fleet must be in\n ACTIVE status before a game session can be created in it.

\n

This operation can be used in the following ways:

\n \n

If successful, a workflow is initiated to start a new game session. A\n GameSession object is returned containing the game session\n configuration and status. When the status is ACTIVE, game session\n connection information is provided and player sessions can be created for the game\n session. By default, newly created game sessions are open to new players. You can\n restrict new player access by using UpdateGameSession to change the\n game session's player session creation policy.

\n

Game session logs are retained for all active game sessions for 14 days. To access the\n logs, call GetGameSessionLogUrl to download the log files.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Learn more\n

\n

\n Start a game session\n

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a multiplayer game session for players in a specific fleet location. This\n operation prompts an available server process to start a game session and retrieves\n connection information for the new game session. As an alternative, consider using the\n GameLift game session placement feature with StartGameSessionPlacement , which uses FleetIQ algorithms and queues to\n optimize the placement process.

\n

When creating a game session, you specify exactly where you want to place it and\n provide a set of game session configuration settings. The fleet must be in\n ACTIVE status before a game session can be created in it.

\n

This operation can be used in the following ways:

\n \n

If successful, a workflow is initiated to start a new game session. A\n GameSession object is returned containing the game session\n configuration and status. When the status is ACTIVE, game session\n connection information is provided and player sessions can be created for the game\n session. By default, newly created game sessions are open to new players. You can\n restrict new player access by using UpdateGameSession to change the game session's player session creation\n policy.

\n

Game session logs are retained for all active game sessions for 14 days. To access the\n logs, call GetGameSessionLogUrl to download the log files.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Learn more\n

\n

\n Start a game session\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateGameSessionInput": { @@ -1172,7 +1369,7 @@ "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).

" } }, "CreatorId": { @@ -1184,30 +1381,27 @@ "GameSessionId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { - "smithy.api#documentation": "

\n This parameter is no longer preferred. Please use\n IdempotencyToken instead. Custom string that uniquely\n identifies a request for a new game session. Maximum token length is 48 characters. If\n provided, this string is included in the new game session's ID.

" + "smithy.api#documentation": "

\n This parameter is deprecated. Use IdempotencyToken\n instead.\n

\n

Custom string that uniquely identifies a request for a new game session. Maximum token\n length is 48 characters. If provided, this string is included in the new game session's\n ID.

" } }, "IdempotencyToken": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { - "smithy.api#documentation": "

Custom string that uniquely identifies the new game session request. This is useful\n for ensuring that game session requests with the same idempotency token are processed\n only once. Subsequent requests with the same string return the original\n GameSession object, with an updated status. Maximum token length is 48\n characters. If provided, this string is included in the new game session's ID.\n A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//. Idempotency tokens remain in use for 30 days after a game session has ended;\n game session objects are retained for this time period and then deleted.

" + "smithy.api#documentation": "

Custom string that uniquely identifies the new game session request. This is useful\n for ensuring that game session requests with the same idempotency token are processed\n only once. Subsequent requests with the same string return the original\n GameSession object, with an updated status. Maximum token length is 48\n characters. If provided, this string is included in the new game session's ID.\n A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//. Idempotency tokens remain in use for 30 days after a game session has ended;\n game session objects are retained for this time period and then deleted.

" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#LargeGameSessionData", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session).

" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

A fleet's remote location to place the new game session in. If this parameter is not\n set, the new game session is placed in the fleet's home Region. Specify a remote\n location with an Amazon Web Services Region code such as us-west-2.

" + "smithy.api#documentation": "

A fleet's remote location to place the new game session in. If this parameter is not\n set, the new game session is placed in the fleet's home Region. Specify a remote\n location with an Amazon Web Services Region code such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateGameSessionOutput": { @@ -1219,9 +1413,6 @@ "smithy.api#documentation": "

Object that describes the newly created game session record.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateGameSessionQueue": { @@ -1253,7 +1444,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a placement queue that processes requests for new game sessions. A queue uses\n FleetIQ algorithms to determine the best placement locations and find an\n available game server there, then prompts the game server process to start a new game\n session.

\n

A game session queue is configured with a set of destinations (GameLift fleets or\n aliases), which determine the locations where the queue can place new game sessions.\n These destinations can span multiple fleet types (Spot and On-Demand), instance types,\n and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place\n game sessions in all of a fleet's remote locations. You can opt to filter out individual\n locations if needed.

\n

The queue configuration also determines how FleetIQ selects the best available placement\n for a new game session. Before searching for an available game server, FleetIQ first\n prioritizes the queue's destinations and locations, with the best placement locations on\n top. You can set up the queue to use the FleetIQ default prioritization or provide an\n alternate set of priorities.

\n

To create a new queue, provide a name, timeout value, and a list of destinations.\n Optionally, specify a sort configuration and/or a filter, and define a set of latency\n cap policies. You can also include the ARN for an Amazon Simple Notification Service\n (SNS) topic to receive notifications of game session placement activity. Notifications\n using SNS or CloudWatch events is the preferred way to track placement activity.

\n

If successful, a new GameSessionQueue object is returned with an assigned\n queue ARN. New game session requests, which are submitted to queue with\n StartGameSessionPlacement\n or \n StartMatchmaking, \n reference a queue's name or ARN.

\n

\n Learn more\n

\n

\n \n Design a game session queue\n

\n

\n \n Create a game session queue\n

\n

\n Related actions\n

\n

\n CreateGameSessionQueue \n |\n DescribeGameSessionQueues\n | \n UpdateGameSessionQueue\n | \n DeleteGameSessionQueue\n | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a placement queue that processes requests for new game sessions. A queue uses\n FleetIQ algorithms to determine the best placement locations and find an available game\n server there, then prompts the game server process to start a new game session.

\n

A game session queue is configured with a set of destinations (GameLift fleets or\n aliases), which determine the locations where the queue can place new game sessions.\n These destinations can span multiple fleet types (Spot and On-Demand), instance types,\n and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to\n place game sessions in all of a fleet's remote locations. You can opt to filter out\n individual locations if needed.

\n

The queue configuration also determines how FleetIQ selects the best available placement\n for a new game session. Before searching for an available game server, FleetIQ first\n prioritizes the queue's destinations and locations, with the best placement locations on\n top. You can set up the queue to use the FleetIQ default prioritization or provide an\n alternate set of priorities.

\n

To create a new queue, provide a name, timeout value, and a list of destinations.\n Optionally, specify a sort configuration and/or a filter, and define a set of latency\n cap policies. You can also include the ARN for an Amazon Simple Notification Service\n (SNS) topic to receive notifications of game session placement activity. Notifications\n using SNS or CloudWatch events is the preferred way to track placement activity.

\n

If successful, a new GameSessionQueue object is returned with an assigned\n queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

\n

\n Learn more\n

\n

\n \n Design a game session queue\n

\n

\n \n Create a game session queue\n

\n

\n Related actions\n

\n

\n CreateGameSessionQueue \n |\n DescribeGameSessionQueues\n | \n UpdateGameSessionQueue\n | \n DeleteGameSessionQueue\n | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateGameSessionQueueInput": { @@ -1299,24 +1490,21 @@ "CustomEventData": { "target": "com.amazonaws.gamelift#QueueCustomEventData", "traits": { - "smithy.api#documentation": "

\n Information to be added to all events that are related to this game session queue.\n

" + "smithy.api#documentation": "

Information to be added to all events that are related to this game session\n queue.

" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#QueueSnsArnStringModel", "traits": { - "smithy.api#documentation": "

An SNS topic ARN that is set up to receive game session placement notifications. See \n Setting up notifications for game session placement.

" + "smithy.api#documentation": "

An SNS topic ARN that is set up to receive game session placement notifications. See\n Setting up\n notifications for game session placement.

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

A list of labels to assign to the new game session queue resource. Tags are developer-defined \n key-value pairs. Tagging\n Amazon Web Services resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new game session queue resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource\n management, access management and cost allocation. For more information, see Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateGameSessionQueueOutput": { @@ -1328,20 +1516,20 @@ "smithy.api#documentation": "

An object that describes the newly created game session queue.

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

Represents the returned data in response to a request operation.

" } }, - "com.amazonaws.gamelift#CreateMatchmakingConfiguration": { + "com.amazonaws.gamelift#CreateLocation": { "type": "operation", "input": { - "target": "com.amazonaws.gamelift#CreateMatchmakingConfigurationInput" + "target": "com.amazonaws.gamelift#CreateLocationInput" }, "output": { - "target": "com.amazonaws.gamelift#CreateMatchmakingConfigurationOutput" + "target": "com.amazonaws.gamelift#CreateLocationOutput" }, "errors": [ + { + "target": "com.amazonaws.gamelift#ConflictException" + }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, @@ -1351,27 +1539,85 @@ { "target": "com.amazonaws.gamelift#LimitExceededException" }, - { - "target": "com.amazonaws.gamelift#NotFoundException" - }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { - "target": "com.amazonaws.gamelift#UnsupportedRegionException" + "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { - "smithy.api#documentation": "

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using\n FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking\n configuration sets out rules for matching players and forming teams. If you're also\n using GameLift hosting, it defines how to start game sessions for each match. Your\n matchmaking system can use multiple configurations to handle different game scenarios.\n All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify the matchmaking configuration to use and\n provide player attributes consistent with that configuration.

\n

To create a matchmaking configuration, you must provide the following: configuration\n name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how\n to evaluate players and find acceptable matches; whether player acceptance is required;\n and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift\n hosting, you also need to identify the game session queue to use when starting a game\n session for the match.

\n

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications.\n Provide the topic ARN in the matchmaking configuration. An alternative method,\n continuously polling ticket status with DescribeMatchmaking, is only\n suitable for games in development with low matchmaking usage.

\n

\n Learn more\n

\n

\n \n Design a FlexMatch matchmaker\n

\n

\n \n Set up FlexMatch event notification\n

\n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a custom location for use in an Anywhere fleet.

" } }, - "com.amazonaws.gamelift#CreateMatchmakingConfigurationInput": { + "com.amazonaws.gamelift#CreateLocationInput": { "type": "structure", "members": { - "Name": { + "LocationName": { + "target": "com.amazonaws.gamelift#CustomInputLocationStringModel", + "traits": { + "smithy.api#documentation": "

A descriptive name for the custom location.

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

A list of labels to assign to the new matchmaking configuration resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource\n management, access management and cost allocation. For more information, see Tagging Amazon Web Services\n Resources in the Amazon Web Services General Rareference.

" + } + } + } + }, + "com.amazonaws.gamelift#CreateLocationOutput": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.gamelift#LocationModel", + "traits": { + "smithy.api#documentation": "

The details of the custom location you created.

" + } + } + } + }, + "com.amazonaws.gamelift#CreateMatchmakingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#CreateMatchmakingConfigurationInput" + }, + "output": { + "target": "com.amazonaws.gamelift#CreateMatchmakingConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#LimitExceededException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using\n FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking\n configuration sets out rules for matching players and forming teams. If you're also\n using GameLift hosting, it defines how to start game sessions for each match. Your\n matchmaking system can use multiple configurations to handle different game scenarios.\n All matchmaking requests identify the matchmaking configuration to use and provide\n player attributes consistent with that configuration.

\n

To create a matchmaking configuration, you must provide the following: configuration\n name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how\n to evaluate players and find acceptable matches; whether player acceptance is required;\n and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift\n hosting, you also need to identify the game session queue to use when starting a game\n session for the match.

\n

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications.\n Provide the topic ARN in the matchmaking configuration.

\n

\n Learn more\n

\n

\n Design a FlexMatch\n matchmaker\n

\n

\n Set up FlexMatch event\n notification\n

" + } + }, + "com.amazonaws.gamelift#CreateMatchmakingConfigurationInput": { + "type": "structure", + "members": { + "Name": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.

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

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking\n request or ticket.

", "smithy.api#required": {} } }, @@ -1384,7 +1630,7 @@ "GameSessionQueueArns": { "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. Queues can be located in any Region. Queues are used to start new\n GameLift-hosted game sessions for matches that are created with this matchmaking\n configuration. If FlexMatchMode is set to STANDALONE, do not\n set this parameter.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. Queues can be located in any Region. Queues are used to start new\n GameLift-hosted game sessions for matches that are created with this matchmaking\n configuration. If FlexMatchMode is set to STANDALONE, do not\n set this parameter.

" } }, "RequestTimeoutSeconds": { @@ -1403,7 +1649,7 @@ "AcceptanceRequired": { "target": "com.amazonaws.gamelift#BooleanModel", "traits": { - "smithy.api#documentation": "

A flag that determines whether a match that was created with this configuration must\n be accepted by the matched players. To require acceptance, set to TRUE.\n With this option enabled, matchmaking tickets use the status\n REQUIRES_ACCEPTANCE to indicate when a completed potential match is\n waiting for player acceptance.

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

A flag that determines whether a match that was created with this configuration must\n be accepted by the matched players. To require acceptance, set to TRUE.\n With this option enabled, matchmaking tickets use the status\n REQUIRES_ACCEPTANCE to indicate when a completed potential match is\n waiting for player acceptance.

", "smithy.api#required": {} } }, @@ -1417,13 +1663,13 @@ "NotificationTarget": { "target": "com.amazonaws.gamelift#SnsArnStringModel", "traits": { - "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications. See \n Setting up notifications for matchmaking for more information.

" + "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications. See \n Setting up notifications for matchmaking for more information.

" } }, "AdditionalPlayerCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to\n STANDALONE.

" + "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to\n STANDALONE.

" } }, "CustomEventData": { @@ -1435,36 +1681,33 @@ "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is\n created for a successful match. This parameter is not used if FlexMatchMode\n is set to STANDALONE.

" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object\n that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is\n created for a successful match. This parameter is not used if FlexMatchMode\n is set to STANDALONE.

" } }, "BackfillMode": { "target": "com.amazonaws.gamelift#BackfillMode", "traits": { - "smithy.api#documentation": "

The method used to backfill game sessions that are created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests\n manually or does not use the match backfill feature. Specify AUTOMATIC to\n have GameLift create a StartMatchBackfill request whenever a game\n session has one or more open slots. Learn more about manual and automatic backfill in\n Backfill Existing Games with FlexMatch. Automatic backfill is not\n available when FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

The method used to backfill game sessions that are created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests\n manually or does not use the match backfill feature. Specify AUTOMATIC to\n have GameLift create a backfill request whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch. Automatic backfill is not available when\n FlexMatchMode is set to STANDALONE.

" } }, "FlexMatchMode": { "target": "com.amazonaws.gamelift#FlexMatchMode", "traits": { - "smithy.api#documentation": "

Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.

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

Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.

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

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined \n key-value pairs. Tagging\n Amazon Web Services resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new matchmaking configuration resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource\n management, access management and cost allocation. For more information, see Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateMatchmakingConfigurationOutput": { @@ -1476,9 +1719,6 @@ "smithy.api#documentation": "

Object that describes the newly created matchmaking configuration.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSet": { @@ -1496,6 +1736,9 @@ { "target": "com.amazonaws.gamelift#InvalidRequestException" }, + { + "target": "com.amazonaws.gamelift#LimitExceededException" + }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, @@ -1504,7 +1747,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match\n to create, such as the number and size of teams. It also sets the parameters for\n acceptable player matches, such as minimum skill level or character type. A rule set is\n used by a MatchmakingConfiguration.

\n

To create a matchmaking rule set, provide unique rule set name and the rule set body\n in JSON format. Rule sets must be defined in the same Region as the matchmaking\n configuration they are used with.

\n

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule\n set syntax using ValidateMatchmakingRuleSet before creating a new rule\n set.

\n

\n Learn more\n

\n \n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match\n to create, such as the number and size of teams. It also sets the parameters for\n acceptable player matches, such as minimum skill level or character type.

\n

To create a matchmaking rule set, provide unique rule set name and the rule set body\n in JSON format. Rule sets must be defined in the same Region as the matchmaking\n configuration they are used with.

\n

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set\n syntax using ValidateMatchmakingRuleSet before creating a new rule set.

\n

\n Learn more\n

\n " } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSetInput": { @@ -1527,12 +1770,9 @@ "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined \n key-value pairs. Tagging\n Amazon Web Services resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new matchmaking rule set resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource\n management, access management and cost allocation. For more information, see Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSetOutput": { @@ -1545,9 +1785,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSession": { @@ -1582,7 +1819,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reserves an open player slot in a game session for a player. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. You can add a group of players\n to a game session with CreatePlayerSessions.

\n

To create a player session, specify a game session ID, player ID, and optionally a set of\n player data.

\n

If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned with a player session ID. The player\n references the player session ID when sending a connection request to the game session,\n and the game server can use it to validate the player reservation with the GameLift service. Player\n sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.\n

\n

\n Available in Amazon GameLift Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

" + "smithy.api#documentation": "

Reserves an open player slot in a game session for a player. New player sessions can\n be created in any game session with an open slot that is in ACTIVE status\n and has a player creation policy of ACCEPT_ALL. You can add a group of\n players to a game session with CreatePlayerSessions .

\n

To create a player session, specify a game session ID, player ID, and optionally a set\n of player data.

\n

If successful, a slot is reserved in the game session for the player and a new\n PlayerSessions object is returned with a player session ID. The player\n references the player session ID when sending a connection request to the game session,\n and the game server can use it to validate the player reservation with the GameLift\n service. Player sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreatePlayerSessionInput": { @@ -1608,9 +1845,6 @@ "smithy.api#documentation": "

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSessionOutput": { @@ -1622,9 +1856,6 @@ "smithy.api#documentation": "

Object that describes the newly created player session record.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSessions": { @@ -1659,7 +1890,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reserves open slots in a game session for a group of players. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. To add a single player to a\n game session, use CreatePlayerSession.

\n

To create player sessions, specify a game session ID and a list of player IDs. Optionally,\n provide a set of player data for each player ID.

\n

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player\n references their player session ID when sending a connection request to the game\n session, and the game server can use it to validate the player reservation with the\n GameLift service. Player sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.\n

\n

\n Available in Amazon GameLift Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

" + "smithy.api#documentation": "

Reserves open slots in a game session for a group of players. New player sessions can\n be created in any game session with an open slot that is in ACTIVE status\n and has a player creation policy of ACCEPT_ALL. To add a single player to a\n game session, use CreatePlayerSession\n

\n

To create player sessions, specify a game session ID and a list of player IDs.\n Optionally, provide a set of player data for each player ID.

\n

If successful, a slot is reserved in the game session for each player, and new\n PlayerSession objects are returned with player session IDs. Each player\n references their player session ID when sending a connection request to the game\n session, and the game server can use it to validate the player reservation with the\n GameLift service. Player sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreatePlayerSessionsInput": { @@ -1685,9 +1916,6 @@ "smithy.api#documentation": "

Map of string pairs, each specifying a player ID and a set of developer-defined\n information related to the player. Amazon GameLift does not use this data, so it can be formatted\n as needed for use in the game. Any player data strings for player IDs that are not\n included in the PlayerIds parameter are ignored.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSessionsOutput": { @@ -1699,9 +1927,6 @@ "smithy.api#documentation": "

A collection of player session objects created for the added players.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateScript": { @@ -1730,7 +1955,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that\n provide configuration settings and optional custom game logic for your game. The script\n is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is\n executed during an active game session.

\n

To create a new script record, specify a script name and provide the script file(s).\n The script files and all dependencies must be zipped into a single file. You can pull\n the zip file from either of these locations:

\n \n

If the call is successful, a new script record is created with a unique script ID. If the \n script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket \n and the script record's storage location reflects this location. If the script file is provided\n as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

\n

\n Learn more\n

\n \n

\n Amazon GameLift Realtime Servers\n

\n

\n Set Up a Role for Amazon GameLift Access\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that\n provide configuration settings and optional custom game logic for your game. The script\n is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is\n executed during an active game session.

\n

To create a new script record, specify a script name and provide the script file(s).\n The script files and all dependencies must be zipped into a single file. You can pull\n the zip file from either of these locations:

\n \n

If the call is successful, a new script record is created with a unique script ID. If\n the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3\n bucket and the script record's storage location reflects this location. If the script\n file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as\n needed for deployment.

\n

\n Learn more\n

\n\n

\n Amazon GameLift Realtime Servers\n

\n

\n Set Up a Role for Amazon GameLift Access\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateScriptInput": { @@ -1739,13 +1964,13 @@ "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.\n

" + "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to\n change this value later.

" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.\n

" + "smithy.api#documentation": "

Version information associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to\n change this value later.

" } }, "StorageLocation": { @@ -1757,13 +1982,13 @@ "ZipFile": { "target": "com.amazonaws.gamelift#ZipBlob", "traits": { - "smithy.api#documentation": "

A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.

\n

When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the \n string \"fileb://\" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

" + "smithy.api#documentation": "

A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.

\n

When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip\n file name. It must be prepended with the string \"fileb://\" to indicate that the file\n data is a binary object. For example: --zip-file\n fileb://myRealtimeScript.zip.

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

A list of labels to assign to the new script resource. Tags are developer-defined \n key-value pairs. Tagging\n Amazon Web Services resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new script resource. Tags are developer-defined\n key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access\n management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and\n ListTagsForResource to add, remove, and view tags. The maximum tag limit\n may be lower than stated. See the Amazon Web Services General Reference for actual tagging\n limits.

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

Requests authorization to create or delete a peer connection between the VPC for\n your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game\n servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've\n received authorization, call CreateVpcPeeringConnection to establish\n the peering connection. For more information, see VPC Peering with Amazon GameLift\n Fleets.

\n

You can peer with VPCs that are owned by any Amazon Web Services account you have access to,\n including the account that you use to manage your Amazon GameLift fleets. You cannot peer with\n VPCs that are in different Regions.

\n

To request authorization to create a connection, call this operation from the Amazon Web Services\n account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to\n enable your game servers to retrieve data from a DynamoDB table, use the account that\n manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC\n that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage\n Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

\n

To request authorization to delete a connection, call this operation from the Amazon Web Services\n account with the VPC that is peered with your Amazon GameLift fleet. Identify the following\n values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the\n Amazon Web Services account that you use to manage Amazon GameLift.

\n

The authorization remains valid for 24 hours unless it is canceled by a call to\n DeleteVpcPeeringAuthorization. You must create or delete the\n peering connection while the authorization is valid.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Requests authorization to create or delete a peer connection between the VPC for your\n Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on\n your fleet to communicate directly with other Amazon Web Services resources. After you've received\n authorization, use CreateVpcPeeringConnection to establish the peering connection. For more\n information, see VPC Peering with Amazon GameLift\n Fleets.

\n

You can peer with VPCs that are owned by any Amazon Web Services account you have access to,\n including the account that you use to manage your Amazon GameLift fleets. You cannot peer with\n VPCs that are in different Regions.

\n

To request authorization to create a connection, call this operation from the Amazon Web Services\n account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable\n your game servers to retrieve data from a DynamoDB table, use the account that manages\n that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you\n want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If\n successful, VPC peering is authorized for the specified VPC.

\n

To request authorization to delete a connection, call this operation from the Amazon Web Services\n account with the VPC that is peered with your Amazon GameLift fleet. Identify the following\n values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the\n Amazon Web Services account that you use to manage Amazon GameLift.

\n

The authorization remains valid for 24 hours unless it is canceled. You must create or\n delete the peering connection while the authorization is valid.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationInput": { @@ -1822,9 +2047,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationOutput": { @@ -1836,9 +2058,6 @@ "smithy.api#documentation": "

Details on the requested VPC peering authorization, including expiration.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnection": { @@ -1864,7 +2083,7 @@ } ], "traits": { - "smithy.api#documentation": "

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC\n for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to\n communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account\n that you have access to, including the account that you use to manage your Amazon GameLift\n fleets. You cannot peer with VPCs that are in different Regions. For more information,\n see VPC Peering with Amazon GameLift Fleets.

\n

Before calling this operation to establish the peering connection, you first need\n to call CreateVpcPeeringAuthorization and identify the VPC you want to\n peer with. Once the authorization for the specified VPC is issued, you have 24 hours to\n establish the connection. These two operations handle all tasks necessary to peer the\n two VPCs, including acceptance, updating routing tables, etc.

\n

To establish the connection, call this operation from the Amazon Web Services account that is used\n to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet\n you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC\n that you want to peer with; and (3) The ID of the VPC you want to peer with. This\n operation is asynchronous. If successful, a VpcPeeringConnection\n request is created. You can use continuous polling to track the request's status using\n DescribeVpcPeeringConnections, or by monitoring fleet events for\n success or failure using DescribeFleetEvents.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC\n for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate\n directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that\n you have access to, including the account that you use to manage your Amazon GameLift fleets. You\n cannot peer with VPCs that are in different Regions. For more information, see VPC\n Peering with Amazon GameLift Fleets.

\n

Before calling this operation to establish the peering connection, you first need to\n use CreateVpcPeeringAuthorization and identify the VPC you want to peer with.\n Once the authorization for the specified VPC is issued, you have 24 hours to establish\n the connection. These two operations handle all tasks necessary to peer the two VPCs,\n including acceptance, updating routing tables, etc.

\n

To establish the connection, call this operation from the Amazon Web Services account that is used\n to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you\n want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that\n you want to peer with; and (3) The ID of the VPC you want to peer with. This operation\n is asynchronous. If successful, a connection request is created. You can use continuous\n polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success\n or failure using DescribeFleetEvents .

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnectionInput": { @@ -1891,9 +2110,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnectionOutput": { @@ -1909,6 +2125,26 @@ } } }, + "com.amazonaws.gamelift#CustomInputLocationStringModel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 64 + }, + "smithy.api#pattern": "^custom-[A-Za-z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#CustomLocationNameOrArnModel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^custom-[A-Za-z0-9\\-]+|^arn:.*:location\\/custom-\\S+$" + } + }, "com.amazonaws.gamelift#DeleteAlias": { "type": "operation", "input": { @@ -1935,7 +2171,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an alias. This operation removes all record of the alias. Game clients\n attempting to access a server process using the deleted alias receive an error. To\n delete an alias, specify the alias ID to be deleted.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes an alias. This operation removes all record of the alias. Game clients\n attempting to access a server process using the deleted alias receive an error. To\n delete an alias, specify the alias ID to be deleted.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DeleteAliasInput": { @@ -1948,9 +2184,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteBuild": { @@ -1979,7 +2212,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a build. This operation permanently deletes the build resource and any uploaded\n build files. Deleting a build does not affect the status of any active fleets using the\n build, but you can no longer create new fleets with the deleted build.

\n

To delete a build, specify the build ID.

\n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes a build. This operation permanently deletes the build resource and any\n uploaded build files. Deleting a build does not affect the status of any active fleets\n using the build, but you can no longer create new fleets with the deleted build.

\n

To delete a build, specify the build ID.

\n

\n Learn more\n

\n

\n Upload a Custom\n Server Build\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DeleteBuildInput": { @@ -1992,9 +2225,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteFleet": { @@ -2026,7 +2256,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes all resources and information related a fleet. Any current fleet instances,\n including those in remote locations, are shut down. You don't need to call\n DeleteFleetLocations separately.

\n \n

If the fleet being deleted has a VPC peering connection, you first need to get a\n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete\n the VPC peering connection--this is done as part of the delete fleet process.

\n \n

To delete a fleet, specify the fleet ID to be terminated. During the deletion process\n the fleet status is changed to DELETING. When completed, the status\n switches to TERMINATED and the fleet event FLEET_DELETED is\n sent.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes all resources and information related a fleet. Any current fleet instances,\n including those in remote locations, are shut down. You don't need to call\n DeleteFleetLocations separately.

\n \n

If the fleet being deleted has a VPC peering connection, you first need to get a\n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the\n VPC peering connection.

\n \n

To delete a fleet, specify the fleet ID to be terminated. During the deletion process\n the fleet status is changed to DELETING. When completed, the status\n switches to TERMINATED and the fleet event FLEET_DELETED is\n sent.

\n

\n Learn more\n

\n

\n Setting up GameLift\n Fleets\n

" } }, "com.amazonaws.gamelift#DeleteFleetInput": { @@ -2039,9 +2269,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteFleetLocations": { @@ -2070,7 +2297,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes locations from a multi-location fleet. When deleting a location, all game\n server process and all instances that are still active in the location are shut down.

\n

To delete fleet locations, identify the fleet ID and provide a list of the locations\n to be deleted.

\n

If successful, GameLift sets the location status to DELETING, and begins\n to shut down existing server processes and terminate instances in each location being\n deleted. When completed, the location status changes to TERMINATED.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n

" + "smithy.api#documentation": "

Removes locations from a multi-location fleet. When deleting a location, all game\n server process and all instances that are still active in the location are shut down.

\n

To delete fleet locations, identify the fleet ID and provide a list of the locations\n to be deleted.

\n

If successful, GameLift sets the location status to DELETING, and begins\n to shut down existing server processes and terminate instances in each location being\n deleted. When completed, the location status changes to TERMINATED.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#DeleteFleetLocationsInput": { @@ -2079,20 +2306,17 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to delete locations for.\n You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.

", "smithy.api#required": {} } }, "Locations": { "target": "com.amazonaws.gamelift#LocationList", "traits": { - "smithy.api#documentation": "

The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as\n us-west-2.

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

The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services\n Region code, such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteFleetLocationsOutput": { @@ -2116,9 +2340,6 @@ "smithy.api#documentation": "

The remote locations that are being deleted, with each location status set to\n DELETING.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DeleteGameServerGroup": { @@ -2144,7 +2365,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Terminates a game server group and permanently deletes the game server group record.\n You have several options for how these resources are impacted when deleting the game\n server group. Depending on the type of delete operation selected, this operation might\n affect these resources:

\n \n

To delete a game server group, identify the game server group to delete and specify\n the type of delete operation to initiate. Game server groups can only be deleted if they\n are in ACTIVE or ERROR status.

\n

If the delete request is successful, a series of operations are kicked off. The game\n server group status is changed to DELETE_SCHEDULED, which prevents new game\n servers from being registered and stops automatic scaling activity. Once all game\n servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources.\n If any of the delete operations fail, the game server group is placed in\n ERROR status.

\n

GameLift FleetIQ emits delete events to Amazon CloudWatch.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Terminates a game server group\n and permanently deletes the game server group record. You have several options for how\n these resources are impacted when deleting the game server group. Depending on the type\n of delete operation selected, this operation might affect these resources:

\n \n

To delete a game server group, identify the game server group to delete and specify\n the type of delete operation to initiate. Game server groups can only be deleted if they\n are in ACTIVE or ERROR status.

\n

If the delete request is successful, a series of operations are kicked off. The game\n server group status is changed to DELETE_SCHEDULED, which prevents new game\n servers from being registered and stops automatic scaling activity. Once all game\n servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources.\n If any of the delete operations fail, the game server group is placed in\n ERROR status.

\n

GameLift FleetIQ emits delete events to Amazon CloudWatch.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#DeleteGameServerGroupInput": { @@ -2153,7 +2374,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group. Use either the name or ARN value.

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

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled \n StartGameSessionPlacement requests that reference the queue will fail.\n To delete a queue, specify the queue name.

\n

\n Learn more\n

\n

\n \n Using Multi-Region Queues\n

\n

\n Related actions\n

\n

\n CreateGameSessionQueue \n |\n DescribeGameSessionQueues\n | \n UpdateGameSessionQueue\n | \n DeleteGameSessionQueue\n | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To\n delete a queue, specify the queue name.

" } }, "com.amazonaws.gamelift#DeleteGameSessionQueueInput": { @@ -2215,12 +2436,51 @@ "smithy.api#required": {} } } + } + }, + "com.amazonaws.gamelift#DeleteGameSessionQueueOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.gamelift#DeleteLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DeleteLocationInput" + }, + "output": { + "target": "com.amazonaws.gamelift#DeleteLocationOutput" }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" + "smithy.api#documentation": "

Deletes a custom location.

\n

Before deleting a custom location, review any fleets currently using the custom\n location and deregister the location if it is in use. For more information see, DeregisterCompute.

" } }, - "com.amazonaws.gamelift#DeleteGameSessionQueueOutput": { + "com.amazonaws.gamelift#DeleteLocationInput": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.gamelift#CustomLocationNameOrArnModel", + "traits": { + "smithy.api#documentation": "

The location name of the custom location to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.gamelift#DeleteLocationOutput": { "type": "structure", "members": {} }, @@ -2250,7 +2510,7 @@ } ], "traits": { - "smithy.api#documentation": "

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the\n configuration name. A matchmaking configuration cannot be deleted if it is being used in\n any active matchmaking tickets.

\n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

" + "smithy.api#documentation": "

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the\n configuration name. A matchmaking configuration cannot be deleted if it is being used in\n any active matchmaking tickets.

" } }, "com.amazonaws.gamelift#DeleteMatchmakingConfigurationInput": { @@ -2259,13 +2519,10 @@ "Name": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { - "smithy.api#documentation": "

A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.

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

A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteMatchmakingConfigurationOutput": { @@ -2298,7 +2555,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule\n set name. Rule sets cannot be deleted if they are currently being used by a matchmaking\n configuration.

\n

\n Learn more\n

\n \n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set\n name. Rule sets cannot be deleted if they are currently being used by a matchmaking\n configuration.

\n

\n Learn more\n

\n " } }, "com.amazonaws.gamelift#DeleteMatchmakingRuleSetInput": { @@ -2307,21 +2564,15 @@ "Name": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", "traits": { - "smithy.api#documentation": "

A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional \"name\"\n field in the rule set body.) You can use either the rule set name or ARN value.

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

A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional \"name\"\n field in the rule set body.) You can use either the rule set name or ARN value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteMatchmakingRuleSetOutput": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" - } + "members": {} }, "com.amazonaws.gamelift#DeleteScalingPolicy": { "type": "operation", @@ -2346,7 +2597,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a fleet scaling policy. Once deleted, the policy is no longer in\n force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling\n policy name and the fleet ID it is associated with.

\n

To temporarily suspend scaling policies, call StopFleetActions.\n This operation suspends all policies for the fleet.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and\n GameLift removes all record of it. To delete a scaling policy, specify both the scaling\n policy name and the fleet ID it is associated with.

\n

To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the\n fleet.

" } }, "com.amazonaws.gamelift#DeleteScalingPolicyInput": { @@ -2366,9 +2617,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteScript": { @@ -2397,7 +2645,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Realtime script. This operation permanently deletes the script record. If\n script files were uploaded, they are also deleted (files stored in an S3 bucket are not\n deleted).

\n

To delete a script, specify the script ID. Before deleting a script, be sure to\n terminate all fleets that are deployed with the script being deleted. Fleet instances\n periodically check for script updates, and if the script record no longer exists, the\n instance will go into an error state and be unable to host game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes a Realtime script. This operation permanently deletes the script record. If\n script files were uploaded, they are also deleted (files stored in an S3 bucket are not\n deleted).

\n

To delete a script, specify the script ID. Before deleting a script, be sure to\n terminate all fleets that are deployed with the script being deleted. Fleet instances\n periodically check for script updates, and if the script record no longer exists, the\n instance will go into an error state and be unable to host game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DeleteScriptInput": { @@ -2435,7 +2683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a pending VPC peering authorization for the specified VPC. If you need to\n delete an existing VPC peering connection, call DeleteVpcPeeringConnection.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Cancels a pending VPC peering authorization for the specified VPC. If you need to\n delete an existing VPC peering connection, use DeleteVpcPeeringConnection.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DeleteVpcPeeringAuthorizationInput": { @@ -2455,9 +2703,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteVpcPeeringAuthorizationOutput": { @@ -2487,7 +2732,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a VPC peering connection. To delete the connection, you must have a valid\n authorization for the VPC peering connection that you want to delete. You can check for\n an authorization by calling DescribeVpcPeeringAuthorizations or\n request a new one using CreateVpcPeeringAuthorization.

\n

Once a valid authorization exists, call this operation from the Amazon Web Services account that is\n used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection\n ID and fleet ID. If successful, the connection is removed.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Removes a VPC peering connection. To delete the connection, you must have a valid\n authorization for the VPC peering connection that you want to delete..

\n

Once a valid authorization exists, call this operation from the Amazon Web Services account that is\n used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID\n and fleet ID. If successful, the connection is removed.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DeleteVpcPeeringConnectionInput": { @@ -2503,16 +2748,62 @@ "VpcPeeringConnectionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

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

A unique identifier for a VPC peering connection.

", "smithy.api#required": {} } } + } + }, + "com.amazonaws.gamelift#DeleteVpcPeeringConnectionOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.gamelift#DeregisterCompute": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DeregisterComputeInput" + }, + "output": { + "target": "com.amazonaws.gamelift#DeregisterComputeOutput" }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" + "smithy.api#documentation": "

Removes a compute resource from the specified fleet. Deregister your compute resources\n before you delete the compute.

" } }, - "com.amazonaws.gamelift#DeleteVpcPeeringConnectionOutput": { + "com.amazonaws.gamelift#DeregisterComputeInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

>A unique identifier for the fleet the compute resource is registered to.

", + "smithy.api#required": {} + } + }, + "ComputeName": { + "target": "com.amazonaws.gamelift#ComputeNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the compute resource you want to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.gamelift#DeregisterComputeOutput": { "type": "structure", "members": {} }, @@ -2539,7 +2830,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Removes the game server from a game server group. As a result of this operation, the\n deregistered game server can no longer be claimed and will not be returned in a list of\n active game servers.

\n

To deregister a game server, specify the game server group and game server ID. If\n successful, this operation emits a CloudWatch event with termination timestamp and\n reason.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Removes the game server from a\n game server group. As a result of this operation, the deregistered game server can no\n longer be claimed and will not be returned in a list of active game servers.

\n

To deregister a game server, specify the game server group and game server ID. If\n successful, this operation emits a CloudWatch event with termination timestamp and\n reason.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#DeregisterGameServerInput": { @@ -2548,7 +2839,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group where the game server is running.

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

Retrieves properties for an alias. This operation returns all alias metadata and\n settings. To get an alias's target fleet ID only, use ResolveAlias.

\n

To get alias properties, specify the alias ID. If successful, the requested alias\n record is returned.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves properties for an alias. This operation returns all alias metadata and\n settings. To get an alias's target fleet ID only, use ResolveAlias.

\n

To get alias properties, specify the alias ID. If successful, the requested alias\n record is returned.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeAliasInput": { @@ -2597,9 +2888,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeAliasOutput": { @@ -2611,9 +2899,6 @@ "smithy.api#documentation": "

The requested alias resource.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeBuild": { @@ -2639,7 +2924,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves properties for a custom game build. To request a build resource, specify a\n build ID. If successful, an object containing the build properties is returned.

\n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves properties for a custom game build. To request a build resource, specify a\n build ID. If successful, an object containing the build properties is returned.

\n

\n Learn more\n

\n

\n Upload a Custom\n Server Build\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeBuildInput": { @@ -2648,13 +2933,10 @@ "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value.

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

A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value.\n

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeBuildOutput": { @@ -2666,9 +2948,62 @@ "smithy.api#documentation": "

Set of properties describing the requested build.

" } } + } + }, + "com.amazonaws.gamelift#DescribeCompute": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DescribeComputeInput" + }, + "output": { + "target": "com.amazonaws.gamelift#DescribeComputeOutput" }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" + "smithy.api#documentation": "

Retrieves properties for a compute resource. To request a compute resource specify the\n fleet ID and compute name. If successful, GameLift returns an object containing the build\n properties.

" + } + }, + "com.amazonaws.gamelift#DescribeComputeInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet the compute is registered to.

", + "smithy.api#required": {} + } + }, + "ComputeName": { + "target": "com.amazonaws.gamelift#ComputeNameOrArn", + "traits": { + "smithy.api#documentation": "

A descriptive label that is associated with the compute resource registered to your fleet.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.gamelift#DescribeComputeOutput": { + "type": "structure", + "members": { + "Compute": { + "target": "com.amazonaws.gamelift#Compute", + "traits": { + "smithy.api#documentation": "

The details of the compute resource you registered to the specified fleet.

" + } + } } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimits": { @@ -2694,7 +3029,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.\n Instance limits control the number of instances, per instance type, per location, that\n your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information\n returned includes the maximum number of instances allowed and your account's current\n usage across all fleets. This information can affect your ability to scale your GameLift\n fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.

\n

Instance limits differ based on whether the instances are deployed in a fleet's home\n Region or in a remote location. For remote locations, limits also differ based on the\n combination of home Region and remote location. All requests must specify an Amazon Web Services Region\n (either explicitly or as your default settings). To get the limit for a remote location,\n you must also specify the location. For example, the following requests all return\n different results:

\n \n

This operation can be used in the following ways:

\n \n

If successful, an EC2InstanceLimits object is returned with limits and\n usage data for each requested instance type.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n \n

\n Related actions\n

\n

\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.\n Instance limits control the number of instances, per instance type, per location, that\n your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information\n returned includes the maximum number of instances allowed and your account's current\n usage across all fleets. This information can affect your ability to scale your GameLift\n fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.

\n

Instance limits differ based on whether the instances are deployed in a fleet's home\n Region or in a remote location. For remote locations, limits also differ based on the\n combination of home Region and remote location. All requests must specify an Amazon Web Services\n Region (either explicitly or as your default settings). To get the limit for a remote\n location, you must also specify the location. For example, the following requests all\n return different results:

\n \n

This operation can be used in the following ways:

\n \n

If successful, an EC2InstanceLimits object is returned with limits and\n usage data for each requested instance type.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimitsInput": { @@ -2712,9 +3047,6 @@ "smithy.api#documentation": "

The name of a remote location to request instance limits for, in the form of an Amazon Web Services\n Region code such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimitsOutput": { @@ -2723,12 +3055,9 @@ "EC2InstanceLimits": { "target": "com.amazonaws.gamelift#EC2InstanceLimitList", "traits": { - "smithy.api#documentation": "

The maximum number of instances for the specified instance\n type.

" + "smithy.api#documentation": "

The maximum number of instances for the specified instance type.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetAttributes": { @@ -2754,7 +3083,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves core fleet-wide properties, including the computing hardware and deployment\n configuration for all instances in the fleet.

\n

This operation can be used in the following ways:

\n \n

When requesting attributes for multiple fleets, use the pagination parameters to\n retrieve results as a set of sequential pages.

\n

If successful, a FleetAttributes object is returned for each fleet\n requested, unless the fleet identifier is not found.

\n \n

Some API operations limit the number of fleet IDs that allowed in one request. If a\n request exceeds this limit, the request fails and the error message contains the\n maximum allowed number.

\n \n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n

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

Retrieves core fleet-wide properties, including the computing hardware and deployment\n configuration for all instances in the fleet.

\n

This operation can be used in the following ways:

\n \n

When requesting attributes for multiple fleets, use the pagination parameters to\n retrieve results as a set of sequential pages.

\n

If successful, a FleetAttributes object is returned for each fleet\n requested, unless the fleet identifier is not found.

\n \n

Some API operations limit the number of fleet IDs that allowed in one request. If\n a request exceeds this limit, the request fails and the error message contains the\n maximum allowed number.

\n \n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2784,9 +3113,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetAttributesOutput": { @@ -2804,9 +3130,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetCapacity": { @@ -2832,7 +3155,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the resource capacity settings for one or more fleets. The data returned\n includes the current fleet capacity (number of EC2 instances), and settings that can\n control how capacity scaling. For fleets with remote locations, this operation retrieves\n data for the fleet's home Region only. See DescribeFleetLocationCapacity to get capacity settings for a fleet's remote locations.

\n

This operation can be used in the following ways:

\n \n

When requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.

\n

If successful, a FleetCapacity object is returned for each requested\n fleet ID. Each FleetCapacity object includes a Location property, which is\n set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects\n are returned only for fleets that currently exist.

\n \n

Some API operations may limit the number of fleet IDs that are allowed in one\n request. If a request exceeds this limit, the request fails and the error message\n includes the maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n GameLift metrics for fleets\n

\n

\n Related actions\n

\n

\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n

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

Retrieves the resource capacity settings for one or more fleets. The data returned\n includes the current fleet capacity (number of EC2 instances), and settings that can\n control how capacity scaling. For fleets with remote locations, this operation retrieves\n data for the fleet's home Region only.

\n

This operation can be used in the following ways:

\n \n

When requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.

\n

If successful, a FleetCapacity object is returned for each requested\n fleet ID. Each FleetCapacity object includes a Location property, which is\n set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects\n are returned only for fleets that currently exist.

\n \n

Some API operations may limit the number of fleet IDs that are allowed in one\n request. If a request exceeds this limit, the request fails and the error message\n includes the maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

\n

\n GameLift metrics for fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2847,7 +3170,7 @@ "FleetIds": { "target": "com.amazonaws.gamelift#FleetIdOrArnList", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN\n value. Leave this parameter empty to retrieve capacity information for all\n fleets.

" + "smithy.api#documentation": "

A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN\n value. Leave this parameter empty to retrieve capacity information for all\n fleets.

" } }, "Limit": { @@ -2862,9 +3185,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetCapacityOutput": { @@ -2882,9 +3202,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetEvents": { @@ -2910,7 +3227,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in\n status, such as during fleet creation and termination, changes in capacity, etc. If a\n fleet has multiple locations, events are also initiated by changes to status and\n capacity in remote locations.

\n

You can specify a time range to limit the result set. Use the pagination parameters to\n retrieve results as a set of sequential pages.

\n

If successful, a collection of event log entries matching the request are\n returned.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n

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

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in\n status, such as during fleet creation and termination, changes in capacity, etc. If a\n fleet has multiple locations, events are also initiated by changes to status and\n capacity in remote locations.

\n

You can specify a time range to limit the result set. Use the pagination parameters to\n retrieve results as a set of sequential pages.

\n

If successful, a collection of event log entries matching the request are\n returned.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2925,7 +3242,7 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.

", "smithy.api#required": {} } }, @@ -2953,9 +3270,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetEventsOutput": { @@ -2964,7 +3278,7 @@ "Events": { "target": "com.amazonaws.gamelift#EventList", "traits": { - "smithy.api#documentation": "

A collection of objects containing event log entries for the specified\n fleet.

" + "smithy.api#documentation": "

A collection of objects containing event log entries for the specified fleet.

" } }, "NextToken": { @@ -2973,9 +3287,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetLocationAttributes": { @@ -3004,7 +3315,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information on a fleet's remote locations, including life-cycle status and\n any suspended fleet activity.

\n

This operation can be used in the following ways:

\n \n

When requesting attributes for multiple locations, use the pagination parameters to\n retrieve results as a set of sequential pages.

\n

If successful, a LocationAttributes object is returned for each requested\n location. If the fleet does not have a requested location, no information is returned.\n This operation does not return the home Region. To get information on a fleet's home\n Region, call DescribeFleetAttributes.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n

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

Retrieves information on a fleet's remote locations, including life-cycle status and\n any suspended fleet activity.

\n

This operation can be used in the following ways:

\n \n

When requesting attributes for multiple locations, use the pagination parameters to\n retrieve results as a set of sequential pages.

\n

If successful, a LocationAttributes object is returned for each requested\n location. If the fleet does not have a requested location, no information is returned.\n This operation does not return the home Region. To get information on a fleet's home\n Region, call DescribeFleetAttributes.

\n

\n Learn more\n

\n

\n Setting\n up GameLift fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3025,13 +3336,13 @@ "Locations": { "target": "com.amazonaws.gamelift#LocationList", "traits": { - "smithy.api#documentation": "

A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as\n us-west-2.

" + "smithy.api#documentation": "

A list of fleet locations to retrieve information for. Specify locations in the form\n of an Amazon Web Services Region code, such as us-west-2.

" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

" + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

" } }, "NextToken": { @@ -3040,9 +3351,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetLocationAttributesOutput": { @@ -3057,13 +3365,13 @@ "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" } }, "LocationAttributes": { "target": "com.amazonaws.gamelift#LocationAttributesList", "traits": { - "smithy.api#documentation": "

Location-specific information on the requested fleet's remote locations.

" + "smithy.api#documentation": "

Location-specific information on the requested fleet's remote locations.

" } }, "NextToken": { @@ -3072,9 +3380,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacity": { @@ -3103,7 +3408,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the resource capacity settings for a fleet location. The data returned\n includes the current capacity (number of EC2 instances) and some scaling settings for\n the requested fleet location. Use this operation to retrieve capacity information for a\n fleet's remote location or home Region (you can also retrieve home Region capacity by\n calling DescribeFleetCapacity).

\n

To retrieve capacity data, identify a fleet and location.

\n

If successful, a FleetCapacity object is returned for the requested fleet\n location.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n GameLift metrics for fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves the resource capacity settings for a fleet location. The data returned\n includes the current capacity (number of EC2 instances) and some scaling settings for\n the requested fleet location. Use this operation to retrieve capacity information for a\n fleet's remote location or home Region (you can also retrieve home Region capacity by\n calling DescribeFleetCapacity).

\n

To retrieve capacity data, identify a fleet and location.

\n

If successful, a FleetCapacity object is returned for the requested fleet\n location.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

\n

\n GameLift metrics for fleets\n

" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacityInput": { @@ -3112,20 +3417,17 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to request location capacity for.\n You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN\n value.

", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as\n us-west-2.

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

The fleet location to retrieve capacity information for. Specify a location in the\n form of an Amazon Web Services Region code, such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacityOutput": { @@ -3137,9 +3439,6 @@ "smithy.api#documentation": "

Resource capacity information for the requested fleet location. Capacity objects are\n returned only for fleets and locations that currently exist.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetLocationUtilization": { @@ -3168,7 +3467,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves current usage data for a fleet location. Utilization data provides a\n snapshot of current game hosting activity at the requested location. Use this operation\n to retrieve utilization information for a fleet's remote location or home Region (you\n can also retrieve home Region utilization by calling\n DescribeFleetUtilization).

\n

To retrieve utilization data, identify a fleet and location.

\n

If successful, a FleetUtilization object is returned for the requested\n fleet location.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n GameLift metrics for fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves current usage data for a fleet location. Utilization data provides a\n snapshot of current game hosting activity at the requested location. Use this operation\n to retrieve utilization information for a fleet's remote location or home Region (you\n can also retrieve home Region utilization by calling\n DescribeFleetUtilization).

\n

To retrieve utilization data, identify a fleet and location.

\n

If successful, a FleetUtilization object is returned for the requested\n fleet location.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

\n

\n GameLift metrics for fleets\n

" } }, "com.amazonaws.gamelift#DescribeFleetLocationUtilizationInput": { @@ -3177,20 +3476,17 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to request location utilization for.\n You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN\n value.

", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as\n us-west-2.

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

The fleet location to retrieve utilization information for. Specify a location in the\n form of an Amazon Web Services Region code, such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetLocationUtilizationOutput": { @@ -3202,9 +3498,6 @@ "smithy.api#documentation": "

Utilization information for the requested fleet location. Utilization objects are\n returned only for fleets and locations that currently exist.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetPortSettings": { @@ -3227,10 +3520,13 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { - "smithy.api#documentation": "

Retrieves a fleet's inbound connection permissions. Connection permissions specify the\n range of IP addresses and port settings that incoming traffic can use to access server\n processes in the fleet. Game sessions that are running on instances in the fleet must\n use connections that fall in this range.

\n

This operation can be used in the following ways:

\n \n

If successful, a set of IpPermission objects is returned for the\n requested fleet ID. When a location is specified, a pending status is included. If the\n requested fleet has been deleted, the result set is empty.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves a fleet's inbound connection permissions. Connection permissions specify the\n range of IP addresses and port settings that incoming traffic can use to access server\n processes in the fleet. Game sessions that are running on instances in the fleet must\n use connections that fall in this range.

\n

This operation can be used in the following ways:

\n \n

If successful, a set of IpPermission objects is returned for the\n requested fleet ID. When a location is specified, a pending status is included. If the\n requested fleet has been deleted, the result set is empty.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsInput": { @@ -3246,12 +3542,9 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

A remote location to check for status of port setting updates. Use the Amazon Web Services Region code\n format, such as us-west-2.

" + "smithy.api#documentation": "

A remote location to check for status of port setting updates. Use the Amazon Web Services Region\n code format, such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsOutput": { @@ -3284,12 +3577,9 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The requested fleet location, expressed as an Amazon Web Services Region code, \n such as us-west-2.

" + "smithy.api#documentation": "

The requested fleet location, expressed as an Amazon Web Services Region code, such as\n us-west-2.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetUtilization": { @@ -3315,7 +3605,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves utilization statistics for one or more fleets. Utilization data provides a\n snapshot of how the fleet's hosting resources are currently being used. For fleets with\n remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a\n fleet's remote locations.

\n

This operation can be used in the following ways:

\n \n

When requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.

\n

If successful, a FleetUtilization object is returned for each\n requested fleet ID, unless the fleet identifier is not found. Each fleet utilization\n object includes a Location property, which is set to the fleet's home\n Region.

\n \n

Some API operations may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n GameLift Metrics for Fleets\n

\n

\n Related actions\n

\n

\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n

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

Retrieves utilization statistics for one or more fleets. Utilization data provides a\n snapshot of how the fleet's hosting resources are currently being used. For fleets with\n remote locations, this operation retrieves data for the fleet's home Region only. See\n DescribeFleetLocationUtilization to get utilization statistics for a\n fleet's remote locations.

\n

This operation can be used in the following ways:

\n \n

When requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.

\n

If successful, a FleetUtilization object is returned for each requested fleet ID, unless the\n fleet identifier is not found. Each fleet utilization object includes a\n Location property, which is set to the fleet's home Region.

\n \n

Some API operations may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift\n Fleets\n

\n

\n GameLift Metrics for Fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3330,7 +3620,7 @@ "FleetIds": { "target": "com.amazonaws.gamelift#FleetIdOrArnList", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN\n value. To retrieve attributes for all current fleets, do not include this parameter.

" + "smithy.api#documentation": "

A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value.\n To retrieve attributes for all current fleets, do not include this parameter.

" } }, "Limit": { @@ -3345,9 +3635,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetUtilizationOutput": { @@ -3365,9 +3652,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameServer": { @@ -3393,7 +3677,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information for a registered game server. Information includes game server\n status, health check info, and the instance that the game server is running on.

\n

To retrieve game server information, specify the game server ID. If successful, the\n requested game server object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information for a\n registered game server. Information includes game server status, health check info, and\n the instance that the game server is running on.

\n

To retrieve game server information, specify the game server ID. If successful, the\n requested game server object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#DescribeGameServerGroup": { @@ -3419,7 +3703,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on a game server group. This operation returns only properties\n related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group,\n such as launch template, auto scaling policies, and maximum/minimum group size, access\n the Auto Scaling group directly.

\n

To get attributes for a game server group, provide a group name or ARN value. If\n successful, a GameServerGroup object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on a\n game server group. This operation returns only properties related to GameLift FleetIQ. To view or\n update properties for the corresponding Auto Scaling group, such as launch template,\n auto scaling policies, and maximum/minimum group size, access the Auto Scaling group\n directly.

\n

To get attributes for a game server group, provide a group name or ARN value. If\n successful, a GameServerGroup object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#DescribeGameServerGroupInput": { @@ -3428,7 +3712,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group. Use either the name or ARN value.

", "smithy.api#required": {} } } @@ -3440,7 +3724,7 @@ "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { - "smithy.api#documentation": "

An object with the property settings for the requested game server group resource.

" + "smithy.api#documentation": "

An object with the property settings for the requested game server group resource.\n

" } } } @@ -3451,7 +3735,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group where the game server is running.

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

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ\n game server group. Use this operation to detect when instances are active or not\n available to host new game servers. If you are looking for instance configuration\n information, call DescribeGameServerGroup or access the corresponding\n Auto Scaling group properties.

\n

To request status for all instances in the game server group, provide a game server\n group ID only. To request status for specific instances, provide the game server group\n ID and one or more instance IDs. Use the pagination parameters to retrieve results in\n sequential segments. If successful, a collection of GameServerInstance\n objects is returned.\n \n

\n

This operation is not designed to be called with every game server claim request; this\n practice can cause you to exceed your API limit, which results in errors. Instead, as a\n best practice, cache the results and refresh your cache no more than once every 10\n seconds.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

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

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves status\n information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group.\n Use this operation to detect when instances are active or not available to host new game\n servers.

\n

To request status for all instances in the game server group, provide a game server\n group ID only. To request status for specific instances, provide the game server group\n ID and one or more instance IDs. Use the pagination parameters to retrieve results in\n sequential segments. If successful, a collection of GameServerInstance\n objects is returned.

\n

This operation is not designed to be called with every game server claim request; this\n practice can cause you to exceed your API limit, which results in errors. Instead, as a\n best practice, cache the results and refresh your cache no more than once every 10\n seconds.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3502,7 +3786,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group. Use either the name or ARN value.

", "smithy.api#required": {} } }, @@ -3515,13 +3799,13 @@ "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

\n The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.\n

" + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

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

\n A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.\n

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } } } @@ -3532,13 +3816,13 @@ "GameServerInstances": { "target": "com.amazonaws.gamelift#GameServerInstances", "traits": { - "smithy.api#documentation": "

\n The collection of requested game server instances. \n

" + "smithy.api#documentation": "

The collection of requested game server instances.

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

\n A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.\n

" + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Retrieves additional game session properties, including the game session protection\n policy in force, a set of one or more game sessions in a specific fleet location. You\n can optionally filter the results by current game session status. Alternatively, use\n SearchGameSessions to request a set of active game sessions that\n are filtered by certain criteria. To retrieve all game session properties, use DescribeGameSessions.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSessionDetail object is returned for each game\n session that matches the request.

\n

\n Learn more\n

\n

\n Find a game session\n

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

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

Retrieves additional game session properties, including the game session protection\n policy in force, a set of one or more game sessions in a specific fleet location. You\n can optionally filter the results by current game session status.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSessionDetail object is returned for each game\n session that matches the request.

\n

\n Learn more\n

\n

\n Find a game session\n

\n

\n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3616,7 +3900,7 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

A fleet location to get game sessions for. You can specify a fleet's home Region or a\n remote location. Use the Amazon Web Services Region code format, such as us-west-2.

" + "smithy.api#documentation": "

A fleet location to get game session details for. You can specify a fleet's home\n Region or a remote location. Use the Amazon Web Services Region code format, such as\n us-west-2.

" } }, "StatusFilter": { @@ -3637,9 +3921,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionDetailsOutput": { @@ -3657,9 +3938,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacement": { @@ -3685,7 +3963,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information, including current status, about a game session placement request.

\n

To get game session placement details, specify the placement ID.

\n

This operation is not designed to be continually called to track game session status. \n This practice can cause you to exceed your API limit, which results in errors. Instead, \n you must configure configure an \n Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling \n with DescribeGameSessionPlacement should only be used for games in development with \n low game session usage.\n

\n \n

If successful, a GameSessionPlacement object is returned.

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves information, including current status, about a game session placement\n request.

\n

To get game session placement details, specify the placement ID.

\n

This operation is not designed to be continually called to track game session status.\n This practice can cause you to exceed your API limit, which results in errors. Instead,\n you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from\n FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement\n should only be used for games in development with low game session usage.

" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacementInput": { @@ -3698,9 +3976,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacementOutput": { @@ -3712,9 +3987,6 @@ "smithy.api#documentation": "

Object that describes the requested game session placement.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionQueues": { @@ -3740,7 +4012,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the properties for one or more game session queues. When requesting\n multiple queues, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a GameSessionQueue object is returned\n for each requested queue. When specifying a list of queues, objects are returned only\n for queues that currently exist in the Region.

\n

\n Learn more\n

\n

\n \n View Your Queues\n

\n

\n Related actions\n

\n

\n CreateGameSessionQueue \n |\n DescribeGameSessionQueues\n | \n UpdateGameSessionQueue\n | \n DeleteGameSessionQueue\n | \n All APIs by task\n

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

Retrieves the properties for one or more game session queues. When requesting multiple\n queues, use the pagination parameters to retrieve results as a set of sequential pages.\n When specifying a list of queues, objects are returned only for queues that currently\n exist in the Region.

\n

\n Learn more\n

\n

\n \n View Your Queues\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3770,9 +4042,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionQueuesOutput": { @@ -3790,9 +4059,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessions": { @@ -3824,7 +4090,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a set of one or more game sessions in a specific fleet location. You can\n optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are\n filtered by certain criteria. To retrieve the protection policy for game sessions, use\n DescribeGameSessionDetails.

\n

This operation is not designed to be continually called to track game session status. \n This practice can cause you to exceed your API limit, which results in errors. Instead, \n you must configure configure an \n Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling \n with DescribeGameSessions should only be used for games in development with \n low game session usage.\n

\n \n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSession object is returned for each game session\n that matches the request.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously poling ticket status with\n DescribeGameSessions should only be used for games in development\n with low matchmaking usage.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Learn more\n

\n

\n Find a game session\n

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

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

Retrieves a set of one or more game sessions in a specific fleet location. You can\n optionally filter the results by current game session status.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSession object is returned for each game session\n that matches the request.

\n

This operation is not designed to be continually called to track game session status.\n This practice can cause you to exceed your API limit, which results in errors. Instead,\n you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or\n queues. Continuously polling with DescribeGameSessions should only be used\n for games in development with low game session usage.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Learn more\n

\n

\n Find a game session\n

\n

\n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3839,7 +4105,7 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

" + "smithy.api#documentation": "

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.\n

" } }, "GameSessionId": { @@ -3857,7 +4123,7 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

A fleet location to get game session details for. You can specify a fleet's home\n Region or a remote location. Use the Amazon Web Services Region code format, such as\n us-west-2.

" + "smithy.api#documentation": "

A fleet location to get game sessions for. You can specify a fleet's home Region or a\n remote location. Use the Amazon Web Services Region code format, such as us-west-2.\n

" } }, "StatusFilter": { @@ -3878,9 +4144,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionsOutput": { @@ -3898,9 +4161,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeInstances": { @@ -3929,7 +4189,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a fleet's instances, including instance IDs, connection\n data, and status.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, an Instance object is returned for each requested\n instance. Instances are not returned in any particular order.

\n

\n Learn more\n

\n

\n Remotely Access Fleet Instances\n

\n

\n Debug Fleet Issues\n

\n \n

\n Related actions\n

\n

\n DescribeInstances | \n GetInstanceAccess | \n DescribeEC2InstanceLimits | \n All APIs by task\n

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

Retrieves information about a fleet's instances, including instance IDs, connection\n data, and status.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, an Instance object is returned for each requested\n instance. Instances are not returned in any particular order.

\n

\n Learn more\n

\n

\n Remotely Access Fleet\n Instances\n

\n

\n Debug Fleet\n Issues\n

\n

\n Related actions\n

\n

\n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3944,14 +4204,14 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN\n value.

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

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN\n value.

", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.gamelift#InstanceId", "traits": { - "smithy.api#documentation": "

A unique identifier for an instance to retrieve. Specify an instance ID or leave\n blank to retrieve all instances in the fleet.

" + "smithy.api#documentation": "

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank\n to retrieve all instances in the fleet.

" } }, "Limit": { @@ -3972,9 +4232,6 @@ "smithy.api#documentation": "

The name of a location to retrieve instance information for, in the form of an Amazon Web Services\n Region code such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeInstancesOutput": { @@ -3992,9 +4249,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmaking": { @@ -4017,7 +4271,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket\n information, including--after a successful match is made--connection information for the\n resulting new game session.

\n

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the\n request is successful, a ticket object is returned for each requested ID that currently\n exists.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously polling ticket status with\n DescribeMatchmaking should only be used for games in development\n with low matchmaking usage.

\n

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n \n Set Up FlexMatch event notification\n

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket\n information, including--after a successful match is made--connection information for the\n resulting new game session.

\n

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request\n is successful, a ticket object is returned for each requested ID that currently\n exists.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide\n the topic ARN in the matchmaking configuration.

\n

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n Set Up FlexMatch event\n notification\n

" } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurations": { @@ -4040,7 +4294,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details of FlexMatch matchmaking configurations.

\n

This operation offers the following options: (1) retrieve all matchmaking\n configurations, (2) retrieve configurations for a specified list, or (3) retrieve all\n configurations that use a specified rule set name. When requesting multiple items, use\n the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a configuration is returned for each requested name. When specifying a\n list of names, only configurations that currently exist are returned.

\n

\n Learn more\n

\n

\n Setting up FlexMatch\n matchmakers\n

\n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

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

Retrieves the details of FlexMatch matchmaking configurations.

\n

This operation offers the following options: (1) retrieve all matchmaking\n configurations, (2) retrieve configurations for a specified list, or (3) retrieve all\n configurations that use a specified rule set name. When requesting multiple items, use\n the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a configuration is returned for each requested name. When specifying a\n list of names, only configurations that currently exist are returned.

\n

\n Learn more\n

\n

\n Setting up FlexMatch matchmakers\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4076,9 +4330,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurationsOutput": { @@ -4096,9 +4347,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingInput": { @@ -4111,9 +4359,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingOutput": { @@ -4125,9 +4370,6 @@ "smithy.api#documentation": "

A collection of existing matchmaking ticket objects matching the request.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSets": { @@ -4153,7 +4395,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details for FlexMatch matchmaking rule sets. You can request all\n existing rule sets for the Region, or provide a list of one or more rule set names. When\n requesting multiple items, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a rule set is returned for each requested name.

\n

\n Learn more\n

\n \n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

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

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing\n rule sets for the Region, or provide a list of one or more rule set names. When\n requesting multiple items, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a rule set is returned for each requested name.

\n

\n Learn more\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4183,9 +4425,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSetsOutput": { @@ -4204,9 +4443,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribePlayerSessions": { @@ -4232,7 +4468,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves properties for one or more player sessions.

\n

This action can be used in the following ways:

\n \n

To request player sessions, specify either a player session ID, game session ID, or player\n ID. You can filter this request by player session status. Use the pagination parameters\n to retrieve results as a set of sequential pages.

\n

If successful, a PlayerSession object is returned for each session that\n matches the request.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

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

Retrieves properties for one or more player sessions.

\n

This action can be used in the following ways:

\n \n

To request player sessions, specify either a player session ID, game session ID, or\n player ID. You can filter this request by player session status. Use the pagination\n parameters to retrieve results as a set of sequential pages.

\n

If successful, a PlayerSession object is returned for each session that\n matches the request.

\n

\n Related actions\n

\n

\n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4265,7 +4501,7 @@ "PlayerSessionStatusFilter": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Player session status to filter results on.

\n

Possible player session statuses include the following:

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

Player session status to filter results on. Note that when a PlayerSessionId or\n PlayerId is provided in a DescribePlayerSessions request, then the\n PlayerSessionStatusFilter has no effect on the response.

\n

Possible player session statuses include the following:

\n " } }, "Limit": { @@ -4280,9 +4516,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribePlayerSessionsOutput": { @@ -4291,7 +4524,7 @@ "PlayerSessions": { "target": "com.amazonaws.gamelift#PlayerSessionList", "traits": { - "smithy.api#documentation": "

A collection of objects containing properties for each player session that matches\n the request.

" + "smithy.api#documentation": "

A collection of objects containing properties for each player session that matches the\n request.

" } }, "NextToken": { @@ -4300,9 +4533,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeRuntimeConfiguration": { @@ -4328,7 +4558,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a fleet's runtime configuration settings. The runtime configuration tells\n GameLift which server processes to run (and how) on each instance in the fleet.

\n

To get the runtime configuration that is currently in forces for a fleet, provide the\n fleet ID.

\n

If successful, a RuntimeConfiguration object is returned for the\n requested fleet. If the requested fleet has been deleted, the result set is\n empty.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Running multiple\n processes on a fleet\n

\n

\n Related actions\n

\n

\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves a fleet's runtime configuration settings. The runtime configuration tells\n GameLift which server processes to run (and how) on each instance in the fleet.

\n

To get the runtime configuration that is currently in forces for a fleet, provide the\n fleet ID.

\n

If successful, a RuntimeConfiguration object is returned for the\n requested fleet. If the requested fleet has been deleted, the result set is\n empty.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

\n

\n Running multiple\n processes on a fleet\n

" } }, "com.amazonaws.gamelift#DescribeRuntimeConfigurationInput": { @@ -4341,9 +4571,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeRuntimeConfigurationOutput": { @@ -4355,9 +4582,6 @@ "smithy.api#documentation": "

Instructions that describe how server processes should be launched and maintained on\n each instance in the fleet.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeScalingPolicies": { @@ -4386,7 +4610,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all scaling policies applied to a fleet.

\n

To get a fleet's scaling policies, specify the fleet ID. You can filter this\n request by policy status, such as to retrieve only active scaling policies. Use the\n pagination parameters to retrieve results as a set of sequential pages. If successful,\n set of ScalingPolicy objects is returned for the fleet.

\n

A fleet may have all of its scaling policies suspended (StopFleetActions). This operation does not affect the status of the scaling\n policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force\n or suspended, call DescribeFleetAttributes and check the stopped\n actions.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

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

Retrieves all scaling policies applied to a fleet.

\n

To get a fleet's scaling policies, specify the fleet ID. You can filter this request\n by policy status, such as to retrieve only active scaling policies. Use the pagination\n parameters to retrieve results as a set of sequential pages. If successful, set of\n ScalingPolicy objects is returned for the fleet.

\n

A fleet may have all of its scaling policies suspended. This operation does not affect\n the status of the scaling policies, which remains ACTIVE.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4408,7 +4632,7 @@ "StatusFilter": { "target": "com.amazonaws.gamelift#ScalingStatusType", "traits": { - "smithy.api#documentation": "

Scaling policy status to filter results on. A scaling policy is only in force when\n in an ACTIVE status.

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

Scaling policy status to filter results on. A scaling policy is only in force when in\n an ACTIVE status.

\n " } }, "Limit": { @@ -4426,12 +4650,9 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

\n The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.\n

" + "smithy.api#documentation": "

The fleet location. If you don't specify this value, the response contains the\n scaling policies of every location in the fleet.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeScalingPoliciesOutput": { @@ -4440,7 +4661,7 @@ "ScalingPolicies": { "target": "com.amazonaws.gamelift#ScalingPolicyList", "traits": { - "smithy.api#documentation": "

A collection of objects containing the scaling policies matching the\n request.

" + "smithy.api#documentation": "

A collection of objects containing the scaling policies matching the request.

" } }, "NextToken": { @@ -4449,9 +4670,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeScript": { @@ -4477,7 +4695,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves properties for a Realtime script.

\n

To request a script record, specify the script ID. If successful, an object containing the script properties \n is returned.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves properties for a Realtime script.

\n

To request a script record, specify the script ID. If successful, an object containing\n the script properties is returned.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeScriptInput": { @@ -4523,7 +4741,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.\n This operation returns all VPC peering authorizations and requests for peering. This\n includes those initiated and received by this account.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.\n This operation returns all VPC peering authorizations and requests for peering. This\n includes those initiated and received by this account.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizationsInput": { @@ -4536,7 +4754,7 @@ "VpcPeeringAuthorizations": { "target": "com.amazonaws.gamelift#VpcPeeringAuthorizationList", "traits": { - "smithy.api#documentation": "

A collection of objects that describe all valid VPC peering operations for the\n current Amazon Web Services account.

" + "smithy.api#documentation": "

A collection of objects that describe all valid VPC peering operations for the current\n Amazon Web Services account.

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

Retrieves information on VPC peering connections. Use this operation to get peering\n information for all fleets or for one specific fleet ID.

\n

To retrieve connection information, call this operation from the Amazon Web Services account that\n is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty\n to retrieve all connection records. If successful, the retrieved information includes\n both active and pending connections. Active connections identify the IpV4 CIDR block\n that the VPC uses to connect.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves information on VPC peering connections. Use this operation to get peering\n information for all fleets or for one specific fleet ID.

\n

To retrieve connection information, call this operation from the Amazon Web Services account that is\n used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to\n retrieve all connection records. If successful, the retrieved information includes both\n active and pending connections. Active connections identify the IpV4 CIDR block that the\n VPC uses to connect.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsInput": { @@ -4576,9 +4794,6 @@ "smithy.api#documentation": "

A unique identifier for the fleet. You can use either the fleet ID or ARN value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsOutput": { @@ -4590,9 +4805,6 @@ "smithy.api#documentation": "

A collection of VPC peering connection records that match the request.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DesiredPlayerSession": { @@ -4612,7 +4824,7 @@ } }, "traits": { - "smithy.api#documentation": "

Player information for use when creating player sessions using a game session\n placement request with StartGameSessionPlacement.

" + "smithy.api#documentation": "

Player information for use when creating player sessions using a game session\n placement request.

" } }, "com.amazonaws.gamelift#DesiredPlayerSessionList": { @@ -4624,22 +4836,32 @@ "com.amazonaws.gamelift#DnsName": { "type": "string" }, - "com.amazonaws.gamelift#Double": { - "type": "double" + "com.amazonaws.gamelift#DnsNameInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_\\-\\.]+$" + } }, - "com.amazonaws.gamelift#DoubleObject": { + "com.amazonaws.gamelift#Double": { "type": "double", "traits": { - "smithy.api#box": {} + "smithy.api#default": 0 } }, + "com.amazonaws.gamelift#DoubleObject": { + "type": "double" + }, "com.amazonaws.gamelift#EC2InstanceCounts": { "type": "structure", "members": { "DESIRED": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

Ideal number of active instances. GameLift will always try to maintain the desired\n number of instances. Capacity is scaled up or down by changing the desired instances.

" + "smithy.api#documentation": "

Ideal number of active instances. GameLift will always try to maintain the desired\n number of instances. Capacity is scaled up or down by changing the desired instances.\n

" } }, "MINIMUM": { @@ -4680,7 +4902,7 @@ } }, "traits": { - "smithy.api#documentation": "

Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and\n terminating counts are non-zero when the fleet capacity is adjusting to a scaling event\n or if access to resources is temporarily affected.

\n

EC2 instance counts are part of FleetCapacity.

" + "smithy.api#documentation": "

Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and\n terminating counts are non-zero when the fleet capacity is adjusting to a scaling event\n or if access to resources is temporarily affected.

" } }, "com.amazonaws.gamelift#EC2InstanceLimit": { @@ -4712,7 +4934,7 @@ } }, "traits": { - "smithy.api#documentation": "

The GameLift service limits for an Amazon EC2 instance type and current utilization. GameLift\n allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or\n location, for use with GameLift. You can request an limit increase for your account by\n using the Service limits page in the GameLift\n console.

\n

\n Related actions\n

\n

\n DescribeEC2InstanceLimits\n

" + "smithy.api#documentation": "

The GameLift service limits for an Amazon EC2 instance type and current utilization. GameLift\n allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region\n or location, for use with GameLift. You can request an limit increase for your account by\n using the Service limits page in the GameLift\n console.

" } }, "com.amazonaws.gamelift#EC2InstanceLimitList": { @@ -4722,2053 +4944,4146 @@ } }, "com.amazonaws.gamelift#EC2InstanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "t2.micro", - "name": "t2_micro" - }, - { - "value": "t2.small", - "name": "t2_small" - }, - { - "value": "t2.medium", - "name": "t2_medium" - }, - { - "value": "t2.large", - "name": "t2_large" - }, - { - "value": "c3.large", - "name": "c3_large" - }, - { - "value": "c3.xlarge", - "name": "c3_xlarge" - }, - { - "value": "c3.2xlarge", - "name": "c3_2xlarge" - }, - { - "value": "c3.4xlarge", - "name": "c3_4xlarge" - }, - { - "value": "c3.8xlarge", - "name": "c3_8xlarge" - }, - { - "value": "c4.large", - "name": "c4_large" - }, - { - "value": "c4.xlarge", - "name": "c4_xlarge" - }, - { - "value": "c4.2xlarge", - "name": "c4_2xlarge" - }, - { - "value": "c4.4xlarge", - "name": "c4_4xlarge" - }, - { - "value": "c4.8xlarge", - "name": "c4_8xlarge" - }, - { - "value": "c5.large", - "name": "c5_large" - }, - { - "value": "c5.xlarge", - "name": "c5_xlarge" - }, - { - "value": "c5.2xlarge", - "name": "c5_2xlarge" - }, - { - "value": "c5.4xlarge", - "name": "c5_4xlarge" - }, - { - "value": "c5.9xlarge", - "name": "c5_9xlarge" - }, - { - "value": "c5.12xlarge", - "name": "c5_12xlarge" - }, - { - "value": "c5.18xlarge", - "name": "c5_18xlarge" - }, - { - "value": "c5.24xlarge", - "name": "c5_24xlarge" - }, - { - "value": "c5a.large", - "name": "c5a_large" - }, - { - "value": "c5a.xlarge", - "name": "c5a_xlarge" - }, - { - "value": "c5a.2xlarge", - "name": "c5a_2xlarge" - }, - { - "value": "c5a.4xlarge", - "name": "c5a_4xlarge" - }, - { - "value": "c5a.8xlarge", - "name": "c5a_8xlarge" - }, - { - "value": "c5a.12xlarge", - "name": "c5a_12xlarge" - }, - { - "value": "c5a.16xlarge", - "name": "c5a_16xlarge" - }, - { - "value": "c5a.24xlarge", - "name": "c5a_24xlarge" - }, - { - "value": "r3.large", - "name": "r3_large" - }, - { - "value": "r3.xlarge", - "name": "r3_xlarge" - }, - { - "value": "r3.2xlarge", - "name": "r3_2xlarge" - }, - { - "value": "r3.4xlarge", - "name": "r3_4xlarge" - }, - { - "value": "r3.8xlarge", - "name": "r3_8xlarge" - }, - { - "value": "r4.large", - "name": "r4_large" - }, - { - "value": "r4.xlarge", - "name": "r4_xlarge" - }, - { - "value": "r4.2xlarge", - "name": "r4_2xlarge" - }, - { - "value": "r4.4xlarge", - "name": "r4_4xlarge" - }, - { - "value": "r4.8xlarge", - "name": "r4_8xlarge" - }, - { - "value": "r4.16xlarge", - "name": "r4_16xlarge" - }, - { - "value": "r5.large", - "name": "r5_large" - }, - { - "value": "r5.xlarge", - "name": "r5_xlarge" - }, - { - "value": "r5.2xlarge", - "name": "r5_2xlarge" - }, - { - "value": "r5.4xlarge", - "name": "r5_4xlarge" - }, - { - "value": "r5.8xlarge", - "name": "r5_8xlarge" - }, - { - "value": "r5.12xlarge", - "name": "r5_12xlarge" - }, - { - "value": "r5.16xlarge", - "name": "r5_16xlarge" - }, - { - "value": "r5.24xlarge", - "name": "r5_24xlarge" - }, - { - "value": "r5a.large", - "name": "r5a_large" - }, - { - "value": "r5a.xlarge", - "name": "r5a_xlarge" - }, - { - "value": "r5a.2xlarge", - "name": "r5a_2xlarge" - }, - { - "value": "r5a.4xlarge", - "name": "r5a_4xlarge" - }, - { - "value": "r5a.8xlarge", - "name": "r5a_8xlarge" - }, - { - "value": "r5a.12xlarge", - "name": "r5a_12xlarge" - }, - { - "value": "r5a.16xlarge", - "name": "r5a_16xlarge" - }, - { - "value": "r5a.24xlarge", - "name": "r5a_24xlarge" - }, - { - "value": "m3.medium", - "name": "m3_medium" - }, - { - "value": "m3.large", - "name": "m3_large" - }, - { - "value": "m3.xlarge", - "name": "m3_xlarge" - }, - { - "value": "m3.2xlarge", - "name": "m3_2xlarge" - }, - { - "value": "m4.large", - "name": "m4_large" - }, - { - "value": "m4.xlarge", - "name": "m4_xlarge" - }, - { - "value": "m4.2xlarge", - "name": "m4_2xlarge" - }, - { - "value": "m4.4xlarge", - "name": "m4_4xlarge" - }, - { - "value": "m4.10xlarge", - "name": "m4_10xlarge" - }, - { - "value": "m5.large", - "name": "m5_large" - }, - { - "value": "m5.xlarge", - "name": "m5_xlarge" - }, - { - "value": "m5.2xlarge", - "name": "m5_2xlarge" - }, - { - "value": "m5.4xlarge", - "name": "m5_4xlarge" - }, - { - "value": "m5.8xlarge", - "name": "m5_8xlarge" - }, - { - "value": "m5.12xlarge", - "name": "m5_12xlarge" - }, - { - "value": "m5.16xlarge", - "name": "m5_16xlarge" - }, - { - "value": "m5.24xlarge", - "name": "m5_24xlarge" - }, - { - "value": "m5a.large", - "name": "m5a_large" - }, - { - "value": "m5a.xlarge", - "name": "m5a_xlarge" - }, - { - "value": "m5a.2xlarge", - "name": "m5a_2xlarge" - }, - { - "value": "m5a.4xlarge", - "name": "m5a_4xlarge" - }, - { - "value": "m5a.8xlarge", - "name": "m5a_8xlarge" - }, - { - "value": "m5a.12xlarge", - "name": "m5a_12xlarge" - }, - { - "value": "m5a.16xlarge", - "name": "m5a_16xlarge" - }, - { - "value": "m5a.24xlarge", - "name": "m5a_24xlarge" - }, - { - "value": "c5d.large", - "name": "c5d_large" - }, - { - "value": "c5d.xlarge", - "name": "c5d_xlarge" - }, - { - "value": "c5d.2xlarge", - "name": "c5d_2xlarge" - }, - { - "value": "c5d.4xlarge", - "name": "c5d_4xlarge" - }, - { - "value": "c5d.9xlarge", - "name": "c5d_9xlarge" - }, - { - "value": "c5d.12xlarge", - "name": "c5d_12xlarge" - }, - { - "value": "c5d.18xlarge", - "name": "c5d_18xlarge" - }, - { - "value": "c5d.24xlarge", - "name": "c5d_24xlarge" - }, - { - "value": "c6a.large", - "name": "c6a_large" - }, - { - "value": "c6a.xlarge", - "name": "c6a_xlarge" - }, - { - "value": "c6a.2xlarge", - "name": "c6a_2xlarge" - }, - { - "value": "c6a.4xlarge", - "name": "c6a_4xlarge" - }, - { - "value": "c6a.8xlarge", - "name": "c6a_8xlarge" - }, - { - "value": "c6a.12xlarge", - "name": "c6a_12xlarge" - }, - { - "value": "c6a.16xlarge", - "name": "c6a_16xlarge" - }, - { - "value": "c6a.24xlarge", - "name": "c6a_24xlarge" - }, - { - "value": "c6i.large", - "name": "c6i_large" - }, - { - "value": "c6i.xlarge", - "name": "c6i_xlarge" - }, - { - "value": "c6i.2xlarge", - "name": "c6i_2xlarge" - }, - { - "value": "c6i.4xlarge", - "name": "c6i_4xlarge" - }, - { - "value": "c6i.8xlarge", - "name": "c6i_8xlarge" - }, - { - "value": "c6i.12xlarge", - "name": "c6i_12xlarge" - }, - { - "value": "c6i.16xlarge", - "name": "c6i_16xlarge" - }, - { - "value": "c6i.24xlarge", - "name": "c6i_24xlarge" - }, - { - "value": "r5d.large", - "name": "r5d_large" - }, - { - "value": "r5d.xlarge", - "name": "r5d_xlarge" - }, - { - "value": "r5d.2xlarge", - "name": "r5d_2xlarge" - }, - { - "value": "r5d.4xlarge", - "name": "r5d_4xlarge" - }, - { - "value": "r5d.8xlarge", - "name": "r5d_8xlarge" - }, - { - "value": "r5d.12xlarge", - "name": "r5d_12xlarge" - }, - { - "value": "r5d.16xlarge", - "name": "r5d_16xlarge" - }, - { - "value": "r5d.24xlarge", - "name": "r5d_24xlarge" - } - ] - } - }, - "com.amazonaws.gamelift#Event": { - "type": "structure", + "type": "enum", "members": { - "EventId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "t2_micro": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet event.

" + "smithy.api#enumValue": "t2.micro" } }, - "ResourceId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "t2_small": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for an event resource, such as a fleet ID.

" + "smithy.api#enumValue": "t2.small" } }, - "EventCode": { - "target": "com.amazonaws.gamelift#EventCode", + "t2_medium": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The type of event being logged.

\n\n \n

\n Fleet state transition events:\n

\n \n \n \n

\n Fleet creation events (ordered by fleet creation activity):\n

\n \n \n \n

\n VPC peering events:\n

\n \n\n \n

\n Spot instance events:\n

\n \n \n \n

\n Spot process events:\n

\n \n \n \n

\n Game session events:\n

\n \n \n \n

\n Other fleet events:\n

\n " + "smithy.api#enumValue": "t2.medium" } }, - "Message": { - "target": "com.amazonaws.gamelift#NonEmptyString", + "t2_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Additional information related to the event.

" + "smithy.api#enumValue": "t2.large" } }, - "EventTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "c3_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#enumValue": "c3.large" } }, - "PreSignedLogUrl": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "c3_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Location of stored logs with additional detail that is related to the event. This\n is useful for debugging issues. The URL is valid for 15 minutes. You can also access\n fleet creation logs through the GameLift console.

" + "smithy.api#enumValue": "c3.xlarge" } - } - }, - "traits": { - "smithy.api#documentation": "

Log entry describing an event that involves GameLift resources (such as a fleet). In\n addition to tracking activity, event codes and messages can provide additional\n information for troubleshooting and debugging problems.

\n

\n Related actions\n

\n

\n DescribeFleetEvents\n

" - } - }, - "com.amazonaws.gamelift#EventCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GENERIC_EVENT", - "name": "GENERIC_EVENT" - }, - { - "value": "FLEET_CREATED", - "name": "FLEET_CREATED" - }, - { - "value": "FLEET_DELETED", - "name": "FLEET_DELETED" - }, - { - "value": "FLEET_SCALING_EVENT", - "name": "FLEET_SCALING_EVENT" - }, - { - "value": "FLEET_STATE_DOWNLOADING", - "name": "FLEET_STATE_DOWNLOADING" - }, - { - "value": "FLEET_STATE_VALIDATING", - "name": "FLEET_STATE_VALIDATING" - }, - { - "value": "FLEET_STATE_BUILDING", - "name": "FLEET_STATE_BUILDING" - }, - { - "value": "FLEET_STATE_ACTIVATING", - "name": "FLEET_STATE_ACTIVATING" - }, - { - "value": "FLEET_STATE_ACTIVE", - "name": "FLEET_STATE_ACTIVE" - }, - { - "value": "FLEET_STATE_ERROR", - "name": "FLEET_STATE_ERROR" - }, - { - "value": "FLEET_INITIALIZATION_FAILED", - "name": "FLEET_INITIALIZATION_FAILED" - }, - { - "value": "FLEET_BINARY_DOWNLOAD_FAILED", - "name": "FLEET_BINARY_DOWNLOAD_FAILED" - }, - { - "value": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", - "name": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND" - }, - { - "value": "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", - "name": "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE" - }, - { - "value": "FLEET_VALIDATION_TIMED_OUT", - "name": "FLEET_VALIDATION_TIMED_OUT" - }, - { - "value": "FLEET_ACTIVATION_FAILED", - "name": "FLEET_ACTIVATION_FAILED" - }, - { - "value": "FLEET_ACTIVATION_FAILED_NO_INSTANCES", - "name": "FLEET_ACTIVATION_FAILED_NO_INSTANCES" - }, - { - "value": "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", - "name": "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED" - }, - { - "value": "SERVER_PROCESS_INVALID_PATH", - "name": "SERVER_PROCESS_INVALID_PATH" - }, - { - "value": "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", - "name": "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT" - }, - { - "value": "SERVER_PROCESS_PROCESS_READY_TIMEOUT", - "name": "SERVER_PROCESS_PROCESS_READY_TIMEOUT" - }, - { - "value": "SERVER_PROCESS_CRASHED", - "name": "SERVER_PROCESS_CRASHED" - }, - { - "value": "SERVER_PROCESS_TERMINATED_UNHEALTHY", - "name": "SERVER_PROCESS_TERMINATED_UNHEALTHY" - }, - { - "value": "SERVER_PROCESS_FORCE_TERMINATED", - "name": "SERVER_PROCESS_FORCE_TERMINATED" - }, - { - "value": "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", - "name": "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT" - }, - { - "value": "GAME_SESSION_ACTIVATION_TIMEOUT", - "name": "GAME_SESSION_ACTIVATION_TIMEOUT" - }, - { - "value": "FLEET_CREATION_EXTRACTING_BUILD", - "name": "FLEET_CREATION_EXTRACTING_BUILD" - }, - { - "value": "FLEET_CREATION_RUNNING_INSTALLER", - "name": "FLEET_CREATION_RUNNING_INSTALLER" - }, - { - "value": "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", - "name": "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG" - }, - { - "value": "FLEET_VPC_PEERING_SUCCEEDED", - "name": "FLEET_VPC_PEERING_SUCCEEDED" - }, - { - "value": "FLEET_VPC_PEERING_FAILED", - "name": "FLEET_VPC_PEERING_FAILED" - }, - { - "value": "FLEET_VPC_PEERING_DELETED", - "name": "FLEET_VPC_PEERING_DELETED" - }, - { - "value": "INSTANCE_INTERRUPTED", - "name": "INSTANCE_INTERRUPTED" + }, + "c3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.2xlarge" } - ] - } - }, - "com.amazonaws.gamelift#EventList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#Event" - } - }, - "com.amazonaws.gamelift#FilterConfiguration": { - "type": "structure", - "members": { - "AllowedLocations": { - "target": "com.amazonaws.gamelift#LocationList", + }, + "c3_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A list of locations to allow game session placement in, in the form of Amazon Web Services Region\n codes such as us-west-2.

" + "smithy.api#enumValue": "c3.4xlarge" } - } - }, - "traits": { - "smithy.api#documentation": "

A list of fleet locations where a game session queue can place new game sessions. You\n can use a filter to temporarily turn off placements for specific locations. For queues\n that have multi-location fleets, you can use a filter configuration allow placement with\n some, but not all of these locations.

\n

Filter configurations are part of a GameSessionQueue.

" - } - }, - "com.amazonaws.gamelift#FleetAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTO_SCALING", - "name": "AutoScaling" + }, + "c3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.8xlarge" } - ] - } - }, - "com.amazonaws.gamelift#FleetActionList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#FleetAction" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.gamelift#FleetArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:.*:fleet\\/fleet-\\S+$" - } - }, - "com.amazonaws.gamelift#FleetAttributes": { - "type": "structure", - "members": { - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + }, + "c4_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet.

" + "smithy.api#enumValue": "c4.large" } }, - "FleetArn": { - "target": "com.amazonaws.gamelift#FleetArn", + "c4_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId\n value.

" + "smithy.api#enumValue": "c4.xlarge" } }, - "FleetType": { - "target": "com.amazonaws.gamelift#FleetType", + "c4_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The kind of instances, On-Demand or Spot, that this fleet uses.

" + "smithy.api#enumValue": "c4.2xlarge" } }, - "InstanceType": { - "target": "com.amazonaws.gamelift#EC2InstanceType", + "c4_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance type that determines the computing resources of each instance in\n the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See\n Amazon Elastic Compute Cloud Instance Types\n for detailed descriptions.

" + "smithy.api#enumValue": "c4.4xlarge" } }, - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "c4_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A human-readable description of the fleet.

" + "smithy.api#enumValue": "c4.8xlarge" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "c5_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

" + "smithy.api#enumValue": "c5.large" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "c5_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#enumValue": "c5.xlarge" } }, - "TerminationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "c5_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#enumValue": "c5.2xlarge" } }, - "Status": { - "target": "com.amazonaws.gamelift#FleetStatus", + "c5_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Current status of the fleet. Possible fleet statuses include the following:

\n " + "smithy.api#enumValue": "c5.4xlarge" } }, - "BuildId": { - "target": "com.amazonaws.gamelift#BuildId", + "c5_9xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for the build resource that is deployed on instances in this fleet.

" + "smithy.api#enumValue": "c5.9xlarge" } }, - "BuildArn": { - "target": "com.amazonaws.gamelift#BuildArn", + "c5_12xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in\n this fleet. In a GameLift build ARN, the resource ID matches the BuildId\n value.

" + "smithy.api#enumValue": "c5.12xlarge" } }, - "ScriptId": { - "target": "com.amazonaws.gamelift#ScriptId", + "c5_18xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

" + "smithy.api#enumValue": "c5.18xlarge" } }, - "ScriptArn": { - "target": "com.amazonaws.gamelift#ScriptArn", + "c5_24xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances\n in this fleet. In a GameLift script ARN, the resource ID matches the\n ScriptId value.

" + "smithy.api#enumValue": "c5.24xlarge" } }, - "ServerLaunchPath": { - "target": "com.amazonaws.gamelift#LaunchPathStringModel", + "c5a_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

\n This parameter is no longer used. Server launch paths\n are now defined using the fleet's RuntimeConfiguration parameter.\n Requests that use this parameter instead continue to be valid.

" + "smithy.api#enumValue": "c5a.large" } }, - "ServerLaunchParameters": { - "target": "com.amazonaws.gamelift#LaunchParametersStringModel", + "c5a_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

\n This parameter is no longer used. Server launch\n parameters are now defined using the fleet's RuntimeConfiguration\n parameter. Requests that use this parameter instead continue to be valid.

" + "smithy.api#enumValue": "c5a.xlarge" } }, - "LogPaths": { - "target": "com.amazonaws.gamelift#StringList", + "c5a_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

\n This parameter is no longer used. Game session log\n paths are now defined using the GameLift server API ProcessReady()\n logParameters. See more information in the Server API Reference.

" + "smithy.api#enumValue": "c5a.2xlarge" } }, - "NewGameSessionProtectionPolicy": { - "target": "com.amazonaws.gamelift#ProtectionPolicy", + "c5a_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The type of game session protection to set on all new instances that are started in\n the fleet.

\n " + "smithy.api#enumValue": "c5a.4xlarge" } }, - "OperatingSystem": { - "target": "com.amazonaws.gamelift#OperatingSystem", + "c5a_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The operating system of the fleet's computing resources. A fleet's operating system is\n determined by the OS of the build or script that is deployed on this fleet.

" + "smithy.api#enumValue": "c5a.8xlarge" } }, - "ResourceCreationLimitPolicy": { - "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", + "c5a_12xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The fleet policy that limits the number of game sessions an individual player can\n create over a span of time.

" + "smithy.api#enumValue": "c5a.12xlarge" } }, - "MetricGroups": { - "target": "com.amazonaws.gamelift#MetricGroupList", + "c5a_16xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch,\n you can view aggregated metrics for fleets that are in a metric group. A fleet can be\n included in only one metric group at a time.

" + "smithy.api#enumValue": "c5a.16xlarge" } }, - "StoppedActions": { - "target": "com.amazonaws.gamelift#FleetActionList", + "c5a_24xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

" + "smithy.api#enumValue": "c5a.24xlarge" } }, - "InstanceRoleArn": { - "target": "com.amazonaws.gamelift#NonEmptyString", + "r3_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for an IAM role that manages access to your Amazon Web Services services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN by using the IAM dashboard in the Amazon Web Services Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server.

" + "smithy.api#enumValue": "r3.large" } }, - "CertificateConfiguration": { - "target": "com.amazonaws.gamelift#CertificateConfiguration", + "r3_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Indicates whether a TLS/SSL certificate was generated for the fleet.

" + "smithy.api#enumValue": "r3.xlarge" } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a GameLift fleet of game hosting resources.

\n

\n Related actions\n

\n

\n CreateFleet | DescribeFleetAttributes\n

" - } - }, - "com.amazonaws.gamelift#FleetAttributesList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#FleetAttributes" - } - }, - "com.amazonaws.gamelift#FleetCapacity": { - "type": "structure", - "members": { - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + }, + "r3_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet associated with the location.

" + "smithy.api#enumValue": "r3.2xlarge" } }, - "FleetArn": { - "target": "com.amazonaws.gamelift#FleetArn", + "r3_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + "smithy.api#enumValue": "r3.4xlarge" } }, - "InstanceType": { - "target": "com.amazonaws.gamelift#EC2InstanceType", + "r3_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance type that is used for all instances in a fleet. The instance type\n determines the computing resources in use, including CPU, memory, storage, and\n networking capacity. See Amazon Elastic Compute Cloud\n Instance Types for detailed descriptions.

" + "smithy.api#enumValue": "r3.8xlarge" } }, - "InstanceCounts": { - "target": "com.amazonaws.gamelift#EC2InstanceCounts", + "r4_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The current instance count and capacity settings for the fleet location.

" + "smithy.api#enumValue": "r4.large" } }, - "Location": { - "target": "com.amazonaws.gamelift#LocationStringModel", + "r4_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The fleet location for the instance count information, expressed as an Amazon Web Services Region\n code, such as us-west-2.

" + "smithy.api#enumValue": "r4.xlarge" } - } - }, - "traits": { - "smithy.api#documentation": "

Current resource capacity settings in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity\n | \n DescribeFleetLocationCapacity\n | \n UpdateFleetCapacity\n

" - } - }, - "com.amazonaws.gamelift#FleetCapacityExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.gamelift#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

The specified fleet has no available instances to fulfill a\n CreateGameSession request. Clients can retry such requests immediately\n or after a waiting period.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.gamelift#FleetCapacityList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#FleetCapacity" - } - }, - "com.amazonaws.gamelift#FleetId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^fleet-\\S+$" - } - }, - "com.amazonaws.gamelift#FleetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#FleetId" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.gamelift#FleetIdOrArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^fleet-\\S+|^arn:.*:fleet\\/fleet-\\S+$" - } - }, - "com.amazonaws.gamelift#FleetIdOrArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#FleetIdOrArn" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.gamelift#FleetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NEW", - "name": "NEW" - }, - { - "value": "DOWNLOADING", - "name": "DOWNLOADING" - }, - { - "value": "VALIDATING", - "name": "VALIDATING" - }, - { - "value": "BUILDING", - "name": "BUILDING" - }, - { - "value": "ACTIVATING", - "name": "ACTIVATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" + }, + "r4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.2xlarge" } - ] - } - }, - "com.amazonaws.gamelift#FleetType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ON_DEMAND", - "name": "OnDemand" - }, - { - "value": "SPOT", - "name": "Spot" + }, + "r4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.4xlarge" } - ] - } - }, - "com.amazonaws.gamelift#FleetUtilization": { - "type": "structure", - "members": { - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + }, + "r4_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet associated with the location.

" + "smithy.api#enumValue": "r4.8xlarge" } }, - "FleetArn": { - "target": "com.amazonaws.gamelift#FleetArn", + "r4_16xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + "smithy.api#enumValue": "r4.16xlarge" } }, - "ActiveServerProcessCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "r5_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The number of server processes in ACTIVE status that are currently\n running across all instances in the fleet location.

" + "smithy.api#enumValue": "r5.large" } }, - "ActiveGameSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "r5_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The number of active game sessions that are currently being hosted across all\n instances in the fleet location.

" + "smithy.api#enumValue": "r5.xlarge" } }, - "CurrentPlayerSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "r5_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The number of active player sessions that are currently being hosted across all\n instances in the fleet location.

" + "smithy.api#enumValue": "r5.2xlarge" } }, - "MaximumPlayerSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "r5_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The maximum number of players allowed across all game sessions that are currently\n being hosted across all instances in the fleet location.

" + "smithy.api#enumValue": "r5.4xlarge" } }, - "Location": { - "target": "com.amazonaws.gamelift#LocationStringModel", + "r5_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region\n code, such as us-west-2.

" + "smithy.api#enumValue": "r5.8xlarge" } - } - }, - "traits": { - "smithy.api#documentation": "

Current resource utilization statistics in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.

\n

\n Related actions\n

\n

\n DescribeFleetUtilization | DescribeFleetLocationUtilization\n

" - } - }, - "com.amazonaws.gamelift#FleetUtilizationList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#FleetUtilization" - } - }, - "com.amazonaws.gamelift#FlexMatchMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDALONE", - "name": "STANDALONE" - }, - { - "value": "WITH_QUEUE", - "name": "WITH_QUEUE" + }, + "r5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.12xlarge" } - ] - } - }, - "com.amazonaws.gamelift#Float": { - "type": "float" - }, - "com.amazonaws.gamelift#FreeText": { - "type": "string" - }, - "com.amazonaws.gamelift#GameLift": { - "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "GameLift", - "arnNamespace": "gamelift", - "cloudFormationName": "GameLift", - "cloudTrailEventSource": "gamelift.amazonaws.com", - "endpointPrefix": "gamelift" }, - "aws.auth#sigv4": { - "name": "gamelift" + "r5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.16xlarge" + } }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "GameLift Service\n

Amazon Web Services provides solutions for hosting session-based multiplayer game servers in the\n cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services\n global computing infrastructure, GameLift helps you deliver high-performance,\n high-reliability, low-cost game servers while dynamically scaling your resource usage to\n meet player demand.

\n

\n About GameLift solutions\n

\n

Get more information on these GameLift solutions in the GameLift Developer Guide.

\n \n

\n About this API Reference\n

\n

This reference guide describes the low-level service API for Amazon Web Services. With each topic\n in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI\n reference. Useful links:

\n ", - "smithy.api#title": "Amazon GameLift", - "smithy.api#xmlNamespace": { - "uri": "http://gamelift.amazonaws.com/doc/" - } - }, - "version": "2015-10-01", - "operations": [ - { - "target": "com.amazonaws.gamelift#AcceptMatch" + "r5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.24xlarge" + } }, - { - "target": "com.amazonaws.gamelift#ClaimGameServer" + "r5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.large" + } }, - { - "target": "com.amazonaws.gamelift#CreateAlias" + "r5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateBuild" + "r5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateFleet" + "r5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateFleetLocations" + "r5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.8xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateGameServerGroup" + "r5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.12xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateGameSession" + "r5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.16xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateGameSessionQueue" + "r5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.24xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateMatchmakingConfiguration" + "m3_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.medium" + } }, - { - "target": "com.amazonaws.gamelift#CreateMatchmakingRuleSet" + "m3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.large" + } }, - { - "target": "com.amazonaws.gamelift#CreatePlayerSession" + "m3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreatePlayerSessions" + "m3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateScript" + "m4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.large" + } }, - { - "target": "com.amazonaws.gamelift#CreateVpcPeeringAuthorization" + "m4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#CreateVpcPeeringConnection" + "m4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteAlias" + "m4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteBuild" + "m4_10xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.10xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteFleet" + "m5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.large" + } }, - { - "target": "com.amazonaws.gamelift#DeleteFleetLocations" + "m5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteGameServerGroup" + "m5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteGameSessionQueue" + "m5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteMatchmakingConfiguration" + "m5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.8xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteMatchmakingRuleSet" + "m5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.12xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteScalingPolicy" + "m5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.16xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteScript" + "m5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.24xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeleteVpcPeeringAuthorization" + "m5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.large" + } }, - { - "target": "com.amazonaws.gamelift#DeleteVpcPeeringConnection" + "m5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DeregisterGameServer" + "m5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeAlias" + "m5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeBuild" + "m5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.8xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeEC2InstanceLimits" + "m5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.12xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetAttributes" + "m5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.16xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetCapacity" + "m5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.24xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetEvents" + "c5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.large" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetLocationAttributes" + "c5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetLocationCapacity" + "c5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetLocationUtilization" + "c5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetPortSettings" + "c5d_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.9xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeFleetUtilization" + "c5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.12xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeGameServer" + "c5d_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.18xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeGameServerGroup" + "c5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.24xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeGameServerInstances" + "c6a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.large" + } }, - { - "target": "com.amazonaws.gamelift#DescribeGameSessionDetails" + "c6a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeGameSessionPlacement" + "c6a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeGameSessionQueues" + "c6a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeGameSessions" + "c6a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.8xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeInstances" + "c6a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.12xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeMatchmaking" + "c6a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.16xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeMatchmakingConfigurations" + "c6a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.24xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeMatchmakingRuleSets" + "c6i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.large" + } }, - { - "target": "com.amazonaws.gamelift#DescribePlayerSessions" + "c6i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeRuntimeConfiguration" + "c6i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeScalingPolicies" + "c6i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeScript" + "c6i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.8xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizations" + "c6i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.12xlarge" + } }, - { - "target": "com.amazonaws.gamelift#DescribeVpcPeeringConnections" + "c6i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.16xlarge" + } }, - { - "target": "com.amazonaws.gamelift#GetGameSessionLogUrl" + "c6i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.24xlarge" + } }, - { - "target": "com.amazonaws.gamelift#GetInstanceAccess" + "r5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.large" + } }, - { - "target": "com.amazonaws.gamelift#ListAliases" + "r5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.xlarge" + } }, - { - "target": "com.amazonaws.gamelift#ListBuilds" + "r5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.2xlarge" + } }, - { - "target": "com.amazonaws.gamelift#ListFleets" + "r5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.4xlarge" + } }, - { - "target": "com.amazonaws.gamelift#ListGameServerGroups" + "r5d_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.8xlarge" + } }, - { - "target": "com.amazonaws.gamelift#ListGameServers" + "r5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.12xlarge" + } }, - { - "target": "com.amazonaws.gamelift#ListScripts" + "r5d_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.16xlarge" + } }, - { - "target": "com.amazonaws.gamelift#ListTagsForResource" + "r5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.24xlarge" + } + } + } + }, + "com.amazonaws.gamelift#Event": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A unique identifier for a fleet event.

" + } }, - { - "target": "com.amazonaws.gamelift#PutScalingPolicy" + "ResourceId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A unique identifier for an event resource, such as a fleet ID.

" + } }, - { - "target": "com.amazonaws.gamelift#RegisterGameServer" + "EventCode": { + "target": "com.amazonaws.gamelift#EventCode", + "traits": { + "smithy.api#documentation": "

The type of event being logged.

\n\n \n

\n Fleet state transition events:\n

\n \n\n \n

\n Fleet creation events (ordered by fleet creation\n activity):\n

\n \n\n \n

\n VPC peering events:\n

\n \n\n \n

\n Spot instance events:\n

\n \n\n \n

\n Server process events:\n

\n \n\n \n

\n Game session events:\n

\n \n\n \n

\n Other fleet events:\n

\n " + } }, - { - "target": "com.amazonaws.gamelift#RequestUploadCredentials" + "Message": { + "target": "com.amazonaws.gamelift#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Additional information related to the event.

" + } }, - { - "target": "com.amazonaws.gamelift#ResolveAlias" + "EventTime": { + "target": "com.amazonaws.gamelift#Timestamp", + "traits": { + "smithy.api#documentation": "

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } }, - { - "target": "com.amazonaws.gamelift#ResumeGameServerGroup" + "PreSignedLogUrl": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

Location of stored logs with additional detail that is related to the event. This is\n useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet\n creation logs through the GameLift console.

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

Log entry describing an event that involves GameLift resources (such as a fleet). In\n addition to tracking activity, event codes and messages can provide additional\n information for troubleshooting and debugging problems.

" + } + }, + "com.amazonaws.gamelift#EventCode": { + "type": "enum", + "members": { + "GENERIC_EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERIC_EVENT" + } }, - { - "target": "com.amazonaws.gamelift#SearchGameSessions" + "FLEET_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_CREATED" + } }, - { - "target": "com.amazonaws.gamelift#StartFleetActions" + "FLEET_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_DELETED" + } }, - { - "target": "com.amazonaws.gamelift#StartGameSessionPlacement" + "FLEET_SCALING_EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_SCALING_EVENT" + } }, - { - "target": "com.amazonaws.gamelift#StartMatchBackfill" + "FLEET_STATE_DOWNLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_DOWNLOADING" + } }, - { - "target": "com.amazonaws.gamelift#StartMatchmaking" + "FLEET_STATE_VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_VALIDATING" + } }, - { - "target": "com.amazonaws.gamelift#StopFleetActions" + "FLEET_STATE_BUILDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_BUILDING" + } }, - { - "target": "com.amazonaws.gamelift#StopGameSessionPlacement" + "FLEET_STATE_ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_ACTIVATING" + } }, - { - "target": "com.amazonaws.gamelift#StopMatchmaking" + "FLEET_STATE_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_ACTIVE" + } }, - { - "target": "com.amazonaws.gamelift#SuspendGameServerGroup" + "FLEET_STATE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_ERROR" + } }, - { - "target": "com.amazonaws.gamelift#TagResource" + "FLEET_INITIALIZATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_INITIALIZATION_FAILED" + } }, - { - "target": "com.amazonaws.gamelift#UntagResource" + "FLEET_BINARY_DOWNLOAD_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_BINARY_DOWNLOAD_FAILED" + } }, - { - "target": "com.amazonaws.gamelift#UpdateAlias" + "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND" + } }, - { - "target": "com.amazonaws.gamelift#UpdateBuild" + "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE" + } }, - { - "target": "com.amazonaws.gamelift#UpdateFleetAttributes" + "FLEET_VALIDATION_TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_VALIDATION_TIMED_OUT" + } }, - { - "target": "com.amazonaws.gamelift#UpdateFleetCapacity" + "FLEET_ACTIVATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_ACTIVATION_FAILED" + } }, - { - "target": "com.amazonaws.gamelift#UpdateFleetPortSettings" + "FLEET_ACTIVATION_FAILED_NO_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_ACTIVATION_FAILED_NO_INSTANCES" + } }, - { - "target": "com.amazonaws.gamelift#UpdateGameServer" + "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED" + } }, - { - "target": "com.amazonaws.gamelift#UpdateGameServerGroup" + "SERVER_PROCESS_INVALID_PATH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_INVALID_PATH" + } }, - { - "target": "com.amazonaws.gamelift#UpdateGameSession" + "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT" + } }, - { - "target": "com.amazonaws.gamelift#UpdateGameSessionQueue" + "SERVER_PROCESS_PROCESS_READY_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_PROCESS_READY_TIMEOUT" + } }, - { - "target": "com.amazonaws.gamelift#UpdateMatchmakingConfiguration" + "SERVER_PROCESS_CRASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_CRASHED" + } }, - { - "target": "com.amazonaws.gamelift#UpdateRuntimeConfiguration" + "SERVER_PROCESS_TERMINATED_UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_TERMINATED_UNHEALTHY" + } }, - { - "target": "com.amazonaws.gamelift#UpdateScript" + "SERVER_PROCESS_FORCE_TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_FORCE_TERMINATED" + } }, - { - "target": "com.amazonaws.gamelift#ValidateMatchmakingRuleSet" + "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT" + } + }, + "GAME_SESSION_ACTIVATION_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GAME_SESSION_ACTIVATION_TIMEOUT" + } + }, + "FLEET_CREATION_EXTRACTING_BUILD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_CREATION_EXTRACTING_BUILD" + } + }, + "FLEET_CREATION_RUNNING_INSTALLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_CREATION_RUNNING_INSTALLER" + } + }, + "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG" + } + }, + "FLEET_VPC_PEERING_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_VPC_PEERING_SUCCEEDED" + } + }, + "FLEET_VPC_PEERING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_VPC_PEERING_FAILED" + } + }, + "FLEET_VPC_PEERING_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_VPC_PEERING_DELETED" + } + }, + "INSTANCE_INTERRUPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_INTERRUPTED" + } + }, + "INSTANCE_RECYCLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_RECYCLED" + } } - ] + } }, - "com.amazonaws.gamelift#GameProperty": { + "com.amazonaws.gamelift#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#Event" + } + }, + "com.amazonaws.gamelift#FilterConfiguration": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.gamelift#GamePropertyKey", - "traits": { - "smithy.api#documentation": "

The game property identifier.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.gamelift#GamePropertyValue", + "AllowedLocations": { + "target": "com.amazonaws.gamelift#LocationList", "traits": { - "smithy.api#documentation": "

The game property value.

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

A list of locations to allow game session placement in, in the form of Amazon Web Services Region\n codes such as us-west-2.

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

Set of key-value pairs that contain information about a game session. When included in\n a game session request, these properties communicate details to be used when setting up\n the new game session. For example, a game property might specify a game mode, level, or\n map. Game properties are passed to the game server process when initiating a new game\n session. For more information, see the GameLift Developer Guide.

" + "smithy.api#documentation": "

A list of fleet locations where a game session queue can place new game sessions. You\n can use a filter to temporarily turn off placements for specific locations. For queues\n that have multi-location fleets, you can use a filter configuration allow placement with\n some, but not all of these locations.

" } }, - "com.amazonaws.gamelift#GamePropertyKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, + "com.amazonaws.gamelift#FleetAction": { + "type": "enum", + "members": { + "AutoScaling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_SCALING" + } + } + } + }, + "com.amazonaws.gamelift#FleetActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#FleetAction" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.gamelift#FleetArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:.*:fleet\\/fleet-\\S+$" + } + }, + "com.amazonaws.gamelift#FleetAttributes": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet.

" + } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId\n value.

" + } + }, + "FleetType": { + "target": "com.amazonaws.gamelift#FleetType", + "traits": { + "smithy.api#documentation": "

Indicates whether to use On-Demand or Spot instances for this fleet. By default, this\n property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the\n fleet is created.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.gamelift#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance type that determines the computing resources of each instance in\n the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See\n Amazon Elastic Compute Cloud Instance Types\n for detailed descriptions.

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

A human-readable description of the fleet.

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

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

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

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

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

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

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

Current status of the fleet. Possible fleet statuses include the following:

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

A unique identifier for the build resource that is deployed on instances in this fleet.

" + } + }, + "BuildArn": { + "target": "com.amazonaws.gamelift#BuildArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in\n this fleet. In a GameLift build ARN, the resource ID matches the BuildId\n value.

" + } + }, + "ScriptId": { + "target": "com.amazonaws.gamelift#ScriptId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

" + } + }, + "ScriptArn": { + "target": "com.amazonaws.gamelift#ScriptArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances\n in this fleet. In a GameLift script ARN, the resource ID matches the\n ScriptId value.

" + } + }, + "ServerLaunchPath": { + "target": "com.amazonaws.gamelift#LaunchPathStringModel", + "traits": { + "smithy.api#documentation": "

\n This parameter is no longer used. Server launch paths\n are now defined using the fleet's\n RuntimeConfiguration\n . Requests that use this parameter instead continue to be valid.

" + } + }, + "ServerLaunchParameters": { + "target": "com.amazonaws.gamelift#LaunchParametersStringModel", + "traits": { + "smithy.api#documentation": "

\n This parameter is no longer used. Server launch\n parameters are now defined using the fleet's runtime configuration\n . Requests that use this parameter instead continue to be valid.

" + } + }, + "LogPaths": { + "target": "com.amazonaws.gamelift#StringList", + "traits": { + "smithy.api#documentation": "

\n This parameter is no longer used. Game session log\n paths are now defined using the GameLift server API ProcessReady()\n logParameters. See more information in the Server API Reference.

" + } + }, + "NewGameSessionProtectionPolicy": { + "target": "com.amazonaws.gamelift#ProtectionPolicy", + "traits": { + "smithy.api#documentation": "

The type of game session protection to set on all new instances that are started in\n the fleet.

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

The operating system of the fleet's computing resources. A fleet's operating system is\n determined by the OS of the build or script that is deployed on this fleet.

" + } + }, + "ResourceCreationLimitPolicy": { + "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy" + }, + "MetricGroups": { + "target": "com.amazonaws.gamelift#MetricGroupList", + "traits": { + "smithy.api#documentation": "

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch,\n you can view aggregated metrics for fleets that are in a metric group. A fleet can be\n included in only one metric group at a time.

" + } + }, + "StoppedActions": { + "target": "com.amazonaws.gamelift#FleetActionList", + "traits": { + "smithy.api#documentation": "

A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.

" + } + }, + "InstanceRoleArn": { + "target": "com.amazonaws.gamelift#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for an IAM role that manages access to your Amazon Web Services services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN by using the IAM dashboard in the Amazon Web Services Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server.

" + } + }, + "CertificateConfiguration": { + "target": "com.amazonaws.gamelift#CertificateConfiguration" + }, + "ComputeType": { + "target": "com.amazonaws.gamelift#ComputeType", + "traits": { + "smithy.api#documentation": "

The type of compute resource used to host your game servers. You can use your own\n compute resources with GameLift Anywhere or use Amazon EC2 instances with managed\n GameLift.

" + } + }, + "AnywhereConfiguration": { + "target": "com.amazonaws.gamelift#AnywhereConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Describes a GameLift fleet of game hosting resources.

\n

\n Related actions\n

" + } + }, + "com.amazonaws.gamelift#FleetAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#FleetAttributes" + } + }, + "com.amazonaws.gamelift#FleetCapacity": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet associated with the location.

" + } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.gamelift#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance type that is used for all instances in a fleet. The instance type\n determines the computing resources in use, including CPU, memory, storage, and\n networking capacity. See Amazon Elastic Compute Cloud\n Instance Types for detailed descriptions.

" + } + }, + "InstanceCounts": { + "target": "com.amazonaws.gamelift#EC2InstanceCounts" + }, + "Location": { + "target": "com.amazonaws.gamelift#LocationStringModel", + "traits": { + "smithy.api#documentation": "

The fleet location for the instance count information, expressed as an Amazon Web Services Region\n code, such as us-west-2.

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

Current resource capacity settings in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | DescribeFleetLocationCapacity | UpdateFleetCapacity\n

" + } + }, + "com.amazonaws.gamelift#FleetCapacityExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.gamelift#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

The specified fleet has no available instances to fulfill a\n CreateGameSession request. Clients can retry such requests immediately\n or after a waiting period.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.gamelift#FleetCapacityList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#FleetCapacity" + } + }, + "com.amazonaws.gamelift#FleetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^fleet-\\S+$" + } + }, + "com.amazonaws.gamelift#FleetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#FleetId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.gamelift#FleetIdOrArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^fleet-\\S+|^arn:.*:fleet\\/fleet-\\S+$" + } + }, + "com.amazonaws.gamelift#FleetIdOrArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#FleetIdOrArn" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.gamelift#FleetStatus": { + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "DOWNLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWNLOADING" + } + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATING" + } + }, + "BUILDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILDING" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + } + } + }, + "com.amazonaws.gamelift#FleetType": { + "type": "enum", + "members": { + "OnDemand": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "Spot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT" + } + } + } + }, + "com.amazonaws.gamelift#FleetUtilization": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet associated with the location.

" + } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + } + }, + "ActiveServerProcessCount": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The number of server processes in ACTIVE status that are currently\n running across all instances in the fleet location.

" + } + }, + "ActiveGameSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The number of active game sessions that are currently being hosted across all\n instances in the fleet location.

" + } + }, + "CurrentPlayerSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The number of active player sessions that are currently being hosted across all\n instances in the fleet location.

" + } + }, + "MaximumPlayerSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The maximum number of players allowed across all game sessions that are currently\n being hosted across all instances in the fleet location.

" + } + }, + "Location": { + "target": "com.amazonaws.gamelift#LocationStringModel", + "traits": { + "smithy.api#documentation": "

The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region\n code, such as us-west-2.

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

Current resource utilization statistics in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.

\n

\n Related actions\n

" + } + }, + "com.amazonaws.gamelift#FleetUtilizationList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#FleetUtilization" + } + }, + "com.amazonaws.gamelift#FlexMatchMode": { + "type": "enum", + "members": { + "STANDALONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDALONE" + } + }, + "WITH_QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WITH_QUEUE" + } + } + } + }, + "com.amazonaws.gamelift#Float": { + "type": "float", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.gamelift#FreeText": { + "type": "string" + }, + "com.amazonaws.gamelift#GameLift": { + "type": "service", + "version": "2015-10-01", + "operations": [ + { + "target": "com.amazonaws.gamelift#AcceptMatch" + }, + { + "target": "com.amazonaws.gamelift#ClaimGameServer" + }, + { + "target": "com.amazonaws.gamelift#CreateAlias" + }, + { + "target": "com.amazonaws.gamelift#CreateBuild" + }, + { + "target": "com.amazonaws.gamelift#CreateFleet" + }, + { + "target": "com.amazonaws.gamelift#CreateFleetLocations" + }, + { + "target": "com.amazonaws.gamelift#CreateGameServerGroup" + }, + { + "target": "com.amazonaws.gamelift#CreateGameSession" + }, + { + "target": "com.amazonaws.gamelift#CreateGameSessionQueue" + }, + { + "target": "com.amazonaws.gamelift#CreateLocation" + }, + { + "target": "com.amazonaws.gamelift#CreateMatchmakingConfiguration" + }, + { + "target": "com.amazonaws.gamelift#CreateMatchmakingRuleSet" + }, + { + "target": "com.amazonaws.gamelift#CreatePlayerSession" + }, + { + "target": "com.amazonaws.gamelift#CreatePlayerSessions" + }, + { + "target": "com.amazonaws.gamelift#CreateScript" + }, + { + "target": "com.amazonaws.gamelift#CreateVpcPeeringAuthorization" + }, + { + "target": "com.amazonaws.gamelift#CreateVpcPeeringConnection" + }, + { + "target": "com.amazonaws.gamelift#DeleteAlias" + }, + { + "target": "com.amazonaws.gamelift#DeleteBuild" + }, + { + "target": "com.amazonaws.gamelift#DeleteFleet" + }, + { + "target": "com.amazonaws.gamelift#DeleteFleetLocations" + }, + { + "target": "com.amazonaws.gamelift#DeleteGameServerGroup" + }, + { + "target": "com.amazonaws.gamelift#DeleteGameSessionQueue" + }, + { + "target": "com.amazonaws.gamelift#DeleteLocation" + }, + { + "target": "com.amazonaws.gamelift#DeleteMatchmakingConfiguration" + }, + { + "target": "com.amazonaws.gamelift#DeleteMatchmakingRuleSet" + }, + { + "target": "com.amazonaws.gamelift#DeleteScalingPolicy" + }, + { + "target": "com.amazonaws.gamelift#DeleteScript" + }, + { + "target": "com.amazonaws.gamelift#DeleteVpcPeeringAuthorization" + }, + { + "target": "com.amazonaws.gamelift#DeleteVpcPeeringConnection" + }, + { + "target": "com.amazonaws.gamelift#DeregisterCompute" + }, + { + "target": "com.amazonaws.gamelift#DeregisterGameServer" + }, + { + "target": "com.amazonaws.gamelift#DescribeAlias" + }, + { + "target": "com.amazonaws.gamelift#DescribeBuild" + }, + { + "target": "com.amazonaws.gamelift#DescribeCompute" + }, + { + "target": "com.amazonaws.gamelift#DescribeEC2InstanceLimits" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetAttributes" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetCapacity" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetEvents" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetLocationAttributes" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetLocationCapacity" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetLocationUtilization" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetPortSettings" + }, + { + "target": "com.amazonaws.gamelift#DescribeFleetUtilization" + }, + { + "target": "com.amazonaws.gamelift#DescribeGameServer" + }, + { + "target": "com.amazonaws.gamelift#DescribeGameServerGroup" + }, + { + "target": "com.amazonaws.gamelift#DescribeGameServerInstances" + }, + { + "target": "com.amazonaws.gamelift#DescribeGameSessionDetails" + }, + { + "target": "com.amazonaws.gamelift#DescribeGameSessionPlacement" + }, + { + "target": "com.amazonaws.gamelift#DescribeGameSessionQueues" + }, + { + "target": "com.amazonaws.gamelift#DescribeGameSessions" + }, + { + "target": "com.amazonaws.gamelift#DescribeInstances" + }, + { + "target": "com.amazonaws.gamelift#DescribeMatchmaking" + }, + { + "target": "com.amazonaws.gamelift#DescribeMatchmakingConfigurations" + }, + { + "target": "com.amazonaws.gamelift#DescribeMatchmakingRuleSets" + }, + { + "target": "com.amazonaws.gamelift#DescribePlayerSessions" + }, + { + "target": "com.amazonaws.gamelift#DescribeRuntimeConfiguration" + }, + { + "target": "com.amazonaws.gamelift#DescribeScalingPolicies" + }, + { + "target": "com.amazonaws.gamelift#DescribeScript" + }, + { + "target": "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizations" + }, + { + "target": "com.amazonaws.gamelift#DescribeVpcPeeringConnections" + }, + { + "target": "com.amazonaws.gamelift#GetComputeAccess" + }, + { + "target": "com.amazonaws.gamelift#GetComputeAuthToken" + }, + { + "target": "com.amazonaws.gamelift#GetGameSessionLogUrl" + }, + { + "target": "com.amazonaws.gamelift#GetInstanceAccess" + }, + { + "target": "com.amazonaws.gamelift#ListAliases" + }, + { + "target": "com.amazonaws.gamelift#ListBuilds" + }, + { + "target": "com.amazonaws.gamelift#ListCompute" + }, + { + "target": "com.amazonaws.gamelift#ListFleets" + }, + { + "target": "com.amazonaws.gamelift#ListGameServerGroups" + }, + { + "target": "com.amazonaws.gamelift#ListGameServers" + }, + { + "target": "com.amazonaws.gamelift#ListLocations" + }, + { + "target": "com.amazonaws.gamelift#ListScripts" + }, + { + "target": "com.amazonaws.gamelift#ListTagsForResource" + }, + { + "target": "com.amazonaws.gamelift#PutScalingPolicy" + }, + { + "target": "com.amazonaws.gamelift#RegisterCompute" + }, + { + "target": "com.amazonaws.gamelift#RegisterGameServer" + }, + { + "target": "com.amazonaws.gamelift#RequestUploadCredentials" + }, + { + "target": "com.amazonaws.gamelift#ResolveAlias" + }, + { + "target": "com.amazonaws.gamelift#ResumeGameServerGroup" + }, + { + "target": "com.amazonaws.gamelift#SearchGameSessions" + }, + { + "target": "com.amazonaws.gamelift#StartFleetActions" + }, + { + "target": "com.amazonaws.gamelift#StartGameSessionPlacement" + }, + { + "target": "com.amazonaws.gamelift#StartMatchBackfill" + }, + { + "target": "com.amazonaws.gamelift#StartMatchmaking" + }, + { + "target": "com.amazonaws.gamelift#StopFleetActions" + }, + { + "target": "com.amazonaws.gamelift#StopGameSessionPlacement" + }, + { + "target": "com.amazonaws.gamelift#StopMatchmaking" + }, + { + "target": "com.amazonaws.gamelift#SuspendGameServerGroup" + }, + { + "target": "com.amazonaws.gamelift#TagResource" + }, + { + "target": "com.amazonaws.gamelift#UntagResource" + }, + { + "target": "com.amazonaws.gamelift#UpdateAlias" + }, + { + "target": "com.amazonaws.gamelift#UpdateBuild" + }, + { + "target": "com.amazonaws.gamelift#UpdateFleetAttributes" + }, + { + "target": "com.amazonaws.gamelift#UpdateFleetCapacity" + }, + { + "target": "com.amazonaws.gamelift#UpdateFleetPortSettings" + }, + { + "target": "com.amazonaws.gamelift#UpdateGameServer" + }, + { + "target": "com.amazonaws.gamelift#UpdateGameServerGroup" + }, + { + "target": "com.amazonaws.gamelift#UpdateGameSession" + }, + { + "target": "com.amazonaws.gamelift#UpdateGameSessionQueue" + }, + { + "target": "com.amazonaws.gamelift#UpdateMatchmakingConfiguration" + }, + { + "target": "com.amazonaws.gamelift#UpdateRuntimeConfiguration" + }, + { + "target": "com.amazonaws.gamelift#UpdateScript" + }, + { + "target": "com.amazonaws.gamelift#ValidateMatchmakingRuleSet" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "GameLift", + "arnNamespace": "gamelift", + "cloudFormationName": "GameLift", + "cloudTrailEventSource": "gamelift.amazonaws.com", + "endpointPrefix": "gamelift" + }, + "aws.auth#sigv4": { + "name": "gamelift" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the\n cloud, including tools for deploying, operating, and scaling game servers. Built on\n Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance,\n high-reliability, low-cost game servers while dynamically scaling your resource usage to\n meet player demand.

\n

\n About GameLift solutions\n

\n

Get more information on these GameLift solutions in the GameLift Developer Guide.

\n \n

\n About this API Reference\n

\n

This reference guide describes the low-level service API for Amazon GameLift. With each topic\n in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI\n reference. Useful links:

\n ", + "smithy.api#title": "Amazon GameLift", + "smithy.api#xmlNamespace": { + "uri": "http://gamelift.amazonaws.com/doc/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://gamelift.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.gamelift#GameLiftServiceSdkEndpointOutput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.gamelift#GameProperty": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.gamelift#GamePropertyKey", + "traits": { + "smithy.api#documentation": "

The game property identifier.

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

The game property value.

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

Set of key-value pairs that contain information about a game session. When included in\n a game session request, these properties communicate details to be used when setting up\n the new game session. For example, a game property might specify a game mode, level, or\n map. Game properties are passed to the game server process when initiating a new game\n session. For more information, see the GameLift Developer Guide.

" + } + }, + "com.amazonaws.gamelift#GamePropertyKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, "max": 32 } } }, - "com.amazonaws.gamelift#GamePropertyList": { + "com.amazonaws.gamelift#GamePropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#GameProperty" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.gamelift#GamePropertyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 96 + } + } + }, + "com.amazonaws.gamelift#GameServer": { + "type": "structure", + "members": { + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupName", + "traits": { + "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running.

" + } + }, + "GameServerGroupArn": { + "target": "com.amazonaws.gamelift#GameServerGroupArn", + "traits": { + "smithy.api#documentation": "

The ARN identifier for the game server group where the game server is located.

" + } + }, + "GameServerId": { + "target": "com.amazonaws.gamelift#GameServerId", + "traits": { + "smithy.api#documentation": "

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game\n server groups in an Amazon Web Services account.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.gamelift#GameServerInstanceId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.

" + } + }, + "ConnectionInfo": { + "target": "com.amazonaws.gamelift#GameServerConnectionInfo", + "traits": { + "smithy.api#documentation": "

The port and IP address that must be used to establish a client connection to the game\n server.

" + } + }, + "GameServerData": { + "target": "com.amazonaws.gamelift#GameServerData", + "traits": { + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers.

" + } + }, + "ClaimStatus": { + "target": "com.amazonaws.gamelift#GameServerClaimStatus", + "traits": { + "smithy.api#documentation": "

Indicates when an available game server has been reserved for gameplay but has not yet\n started hosting a game. Once it is claimed, the game server remains in\n CLAIMED status for a maximum of one minute. During this time, game\n clients connect to the game server to start the game and trigger the game server to\n update its utilization status. After one minute, the game server claim status reverts to\n null.

" + } + }, + "UtilizationStatus": { + "target": "com.amazonaws.gamelift#GameServerUtilizationStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether the game server is currently available for new games or is busy.\n Possible statuses include:

\n " + } + }, + "RegistrationTime": { + "target": "com.amazonaws.gamelift#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp that indicates when the game server registered. The format is a number expressed in Unix\n time as milliseconds (for example \"1469498468.057\").

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

Timestamp that indicates the last time the game server was claimed. The format is a\n number expressed in Unix time as milliseconds (for example\n \"1469498468.057\"). This value is used to calculate when a claimed game\n server's status should revert to null.

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

Timestamp that indicates the last time the game server was updated with health status.\n The format is a number expressed in Unix time as milliseconds (for example\n \"1469498468.057\"). After game server registration, this property is\n only changed when a game server update specifies a health check value.

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Properties describing a game server that\n is running on an instance in a game server group.

\n

A game server is created by a successful call to RegisterGameServer and\n deleted by calling DeregisterGameServer. A game server is claimed to host a\n game session by calling ClaimGameServer.

" + } + }, + "com.amazonaws.gamelift#GameServerClaimStatus": { + "type": "enum", + "members": { + "CLAIMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLAIMED" + } + } + } + }, + "com.amazonaws.gamelift#GameServerConnectionInfo": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.gamelift#GameServerData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.gamelift#GameServerGroup": { + "type": "structure", + "members": { + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupName", + "traits": { + "smithy.api#documentation": "

A developer-defined identifier for the game server group. The name is unique for each\n Region in each Amazon Web Services account.

" + } + }, + "GameServerGroupArn": { + "target": "com.amazonaws.gamelift#GameServerGroupArn", + "traits": { + "smithy.api#documentation": "

A generated unique ID for the game server group.

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

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

" + } + }, + "InstanceDefinitions": { + "target": "com.amazonaws.gamelift#InstanceDefinitions", + "traits": { + "smithy.api#documentation": "

The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically\n scaling instances in the corresponding Auto Scaling group.

" + } + }, + "BalancingStrategy": { + "target": "com.amazonaws.gamelift#BalancingStrategy", + "traits": { + "smithy.api#documentation": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:

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

A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by Amazon Web Services regardless of protection status.

" + } + }, + "AutoScalingGroupArn": { + "target": "com.amazonaws.gamelift#AutoScalingGroupArn", + "traits": { + "smithy.api#documentation": "

A generated unique ID for the Amazon EC2 Auto Scaling group that is associated with this\n game server group.

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

The current status of the game server group. Possible statuses include:

\n " + } + }, + "StatusReason": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

Additional information about the current game server group status. This information\n might provide additional insight on groups that are in ERROR status.

" + } + }, + "SuspendedActions": { + "target": "com.amazonaws.gamelift#GameServerGroupActions", + "traits": { + "smithy.api#documentation": "

A list of activities that are currently suspended for this game server group. If this\n property is empty, all activities are occurring.

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

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

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

A timestamp that indicates when this game server group was last updated.

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Properties that describe a game\n server group resource. A game server group manages certain properties related to a\n corresponding Amazon EC2 Auto Scaling group.

\n

A game server group is created by a successful call to\n CreateGameServerGroup and deleted by calling\n DeleteGameServerGroup. Game server group activity can be temporarily\n suspended and resumed by calling SuspendGameServerGroup and\n ResumeGameServerGroup, respectively.

" + } + }, + "com.amazonaws.gamelift#GameServerGroupAction": { + "type": "enum", + "members": { + "REPLACE_INSTANCE_TYPES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_INSTANCE_TYPES" + } + } + } + }, + "com.amazonaws.gamelift#GameServerGroupActions": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#GameProperty" + "target": "com.amazonaws.gamelift#GameServerGroupAction" }, "traits": { "smithy.api#length": { - "min": 0, - "max": 16 + "min": 1, + "max": 1 } } }, - "com.amazonaws.gamelift#GamePropertyValue": { + "com.amazonaws.gamelift#GameServerGroupArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 0, - "max": 96 - } + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]*$" } }, - "com.amazonaws.gamelift#GameServer": { + "com.amazonaws.gamelift#GameServerGroupAutoScalingPolicy": { "type": "structure", "members": { - "GameServerGroupName": { - "target": "com.amazonaws.gamelift#GameServerGroupName", + "EstimatedInstanceWarmup": { + "target": "com.amazonaws.gamelift#PositiveInteger", + "traits": { + "smithy.api#documentation": "

Length of time, in seconds, it takes for a new instance to start new game server\n processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly\n with game servers that take a long time to start up, because it avoids prematurely\n starting new instances.

" + } + }, + "TargetTrackingConfiguration": { + "target": "com.amazonaws.gamelift#TargetTrackingConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for a target-based scaling policy applied to Auto Scaling group. These\n settings are used to create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Configuration\n settings for intelligent automatic scaling that uses target tracking. These settings are\n used to add an Auto Scaling policy when creating the corresponding Auto Scaling group.\n After the Auto Scaling group is created, all updates to Auto Scaling policies, including\n changing this policy and adding or removing other policies, is done directly on the Auto\n Scaling group.

" + } + }, + "com.amazonaws.gamelift#GameServerGroupDeleteOption": { + "type": "enum", + "members": { + "SAFE_DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAFE_DELETE" + } + }, + "FORCE_DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORCE_DELETE" + } + }, + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + } + } + }, + "com.amazonaws.gamelift#GameServerGroupInstanceType": { + "type": "enum", + "members": { + "c4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.large" + } + }, + "c4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.xlarge" + } + }, + "c4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.2xlarge" + } + }, + "c4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.4xlarge" + } + }, + "c4_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.8xlarge" + } + }, + "c5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.large" + } + }, + "c5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.xlarge" + } + }, + "c5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.2xlarge" + } + }, + "c5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.4xlarge" + } + }, + "c5_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.9xlarge" + } + }, + "c5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.12xlarge" + } + }, + "c5_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.18xlarge" + } + }, + "c5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.24xlarge" + } + }, + "c5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.large" + } + }, + "c5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.xlarge" + } + }, + "c5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.2xlarge" + } + }, + "c5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.4xlarge" + } + }, + "c5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.8xlarge" + } + }, + "c5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.12xlarge" + } + }, + "c5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.16xlarge" + } + }, + "c5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.24xlarge" + } + }, + "c6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.medium" + } + }, + "c6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.large" + } + }, + "c6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.xlarge" + } + }, + "c6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.2xlarge" + } + }, + "c6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.4xlarge" + } + }, + "c6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.8xlarge" + } + }, + "c6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.12xlarge" + } + }, + "c6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.16xlarge" + } + }, + "r4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.large" + } + }, + "r4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.xlarge" + } + }, + "r4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.2xlarge" + } + }, + "r4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.4xlarge" + } + }, + "r4_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.8xlarge" + } + }, + "r4_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.16xlarge" + } + }, + "r5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.large" + } + }, + "r5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.xlarge" + } + }, + "r5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.2xlarge" + } + }, + "r5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.4xlarge" + } + }, + "r5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.8xlarge" + } + }, + "r5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.12xlarge" + } + }, + "r5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.16xlarge" + } + }, + "r5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.24xlarge" + } + }, + "r5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.large" + } + }, + "r5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.xlarge" + } + }, + "r5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.2xlarge" + } + }, + "r5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.4xlarge" + } + }, + "r5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.8xlarge" + } + }, + "r5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.12xlarge" + } + }, + "r5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.16xlarge" + } + }, + "r5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.24xlarge" + } + }, + "r6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.medium" + } + }, + "r6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.large" + } + }, + "r6g_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

" + "smithy.api#enumValue": "r6g.xlarge" } }, - "GameServerGroupArn": { - "target": "com.amazonaws.gamelift#GameServerGroupArn", + "r6g_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ARN identifier for the game server group where the game server is located.

" + "smithy.api#enumValue": "r6g.2xlarge" } }, - "GameServerId": { - "target": "com.amazonaws.gamelift#GameServerId", + "r6g_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A custom string that uniquely identifies the game server. Game server IDs are\n developer-defined and are unique across all game server groups in an Amazon Web Services\n account.

" + "smithy.api#enumValue": "r6g.4xlarge" } }, - "InstanceId": { - "target": "com.amazonaws.gamelift#GameServerInstanceId", + "r6g_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.

" + "smithy.api#enumValue": "r6g.8xlarge" } }, - "ConnectionInfo": { - "target": "com.amazonaws.gamelift#GameServerConnectionInfo", + "r6g_12xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The port and IP address that must be used to establish a client connection to the game server.

" + "smithy.api#enumValue": "r6g.12xlarge" } }, - "GameServerData": { - "target": "com.amazonaws.gamelift#GameServerData", + "r6g_16xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" + "smithy.api#enumValue": "r6g.16xlarge" } }, - "ClaimStatus": { - "target": "com.amazonaws.gamelift#GameServerClaimStatus", + "m4_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Indicates when an available game server has been reserved for gameplay but has not yet\n started hosting a game. Once it is claimed, the game server remains in\n CLAIMED status for a maximum of one minute. During this time, game\n clients connect to the game server to start the game and trigger the game server to\n update its utilization status. After one minute, the game server claim status reverts to\n null.

" + "smithy.api#enumValue": "m4.large" } }, - "UtilizationStatus": { - "target": "com.amazonaws.gamelift#GameServerUtilizationStatus", + "m4_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

\n " + "smithy.api#enumValue": "m4.xlarge" } }, - "RegistrationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "m4_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix\n time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#enumValue": "m4.2xlarge" } }, - "LastClaimTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "m4_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time\n as milliseconds (for example \"1469498468.057\"). This value is used to\n calculate when a claimed game server's status should revert to null.

" + "smithy.api#enumValue": "m4.4xlarge" } }, - "LastHealthCheckTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "m4_10xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Timestamp that indicates the last time the game server was updated with health status\n using an UpdateGameServer request. The format is a number expressed in\n Unix time as milliseconds (for example \"1469498468.057\"). After game server\n registration, this property is only changed when a game server update specifies a health\n check value.

" + "smithy.api#enumValue": "m4.10xlarge" } - } - }, - "traits": { - "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Properties describing a game server that is running on an instance in a GameServerGroup.

\n

A game server is created by a successful call to RegisterGameServer and\n deleted by calling DeregisterGameServer. A game server is claimed to host a\n game session by calling ClaimGameServer.

\n

\n Related actions\n

\n

\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n

" - } - }, - "com.amazonaws.gamelift#GameServerClaimStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CLAIMED", - "name": "CLAIMED" + }, + "m5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.large" } - ] - } - }, - "com.amazonaws.gamelift#GameServerConnectionInfo": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.gamelift#GameServerData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 + "m5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.xlarge" + } }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.gamelift#GameServerGroup": { - "type": "structure", - "members": { - "GameServerGroupName": { - "target": "com.amazonaws.gamelift#GameServerGroupName", + "m5_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A developer-defined identifier for the game server group. The name is unique for each\n Region in each Amazon Web Services account.

" + "smithy.api#enumValue": "m5.2xlarge" } }, - "GameServerGroupArn": { - "target": "com.amazonaws.gamelift#GameServerGroupArn", + "m5_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A generated unique ID for the game server group.

" + "smithy.api#enumValue": "m5.4xlarge" } }, - "RoleArn": { - "target": "com.amazonaws.gamelift#IamRoleArn", + "m5_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

" + "smithy.api#enumValue": "m5.8xlarge" } }, - "InstanceDefinitions": { - "target": "com.amazonaws.gamelift#InstanceDefinitions", + "m5_12xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically\n scaling instances in the corresponding Auto Scaling group.

" + "smithy.api#enumValue": "m5.12xlarge" } }, - "BalancingStrategy": { - "target": "com.amazonaws.gamelift#BalancingStrategy", + "m5_16xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:

\n " + "smithy.api#enumValue": "m5.16xlarge" } }, - "GameServerProtectionPolicy": { - "target": "com.amazonaws.gamelift#GameServerProtectionPolicy", + "m5_24xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by Amazon Web Services regardless of protection status.

" + "smithy.api#enumValue": "m5.24xlarge" } }, - "AutoScalingGroupArn": { - "target": "com.amazonaws.gamelift#AutoScalingGroupArn", + "m5a_large": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A generated unique ID for the Amazon EC2 Auto Scaling group that is associated with this\n game server group.

" + "smithy.api#enumValue": "m5a.large" } }, - "Status": { - "target": "com.amazonaws.gamelift#GameServerGroupStatus", + "m5a_xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The current status of the game server group. Possible statuses include:

\n " + "smithy.api#enumValue": "m5a.xlarge" } }, - "StatusReason": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "m5a_2xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Additional information about the current game server group status. This information\n might provide additional insight on groups that are in ERROR status.

" + "smithy.api#enumValue": "m5a.2xlarge" } }, - "SuspendedActions": { - "target": "com.amazonaws.gamelift#GameServerGroupActions", + "m5a_4xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A list of activities that are currently suspended for this game server group.\n If this property is empty, all activities are occurring.

" + "smithy.api#enumValue": "m5a.4xlarge" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "m5a_8xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#enumValue": "m5a.8xlarge" } }, - "LastUpdatedTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "m5a_12xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when this game server group was last updated.

" + "smithy.api#enumValue": "m5a.12xlarge" } - } - }, - "traits": { - "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Properties that describe a game server group resource. A game server group manages\n certain properties related to a corresponding Amazon EC2 Auto Scaling group.

\n

A game server group is created by a successful call to\n CreateGameServerGroup and deleted by calling\n DeleteGameServerGroup. Game server group activity can be temporarily\n suspended and resumed by calling SuspendGameServerGroup and\n ResumeGameServerGroup, respectively.

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" - } - }, - "com.amazonaws.gamelift#GameServerGroupAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REPLACE_INSTANCE_TYPES", - "name": "REPLACE_INSTANCE_TYPES" + }, + "m5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.16xlarge" } - ] - } - }, - "com.amazonaws.gamelift#GameServerGroupActions": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#GameServerGroupAction" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.gamelift#GameServerGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 }, - "smithy.api#pattern": "^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]*$" - } - }, - "com.amazonaws.gamelift#GameServerGroupAutoScalingPolicy": { - "type": "structure", - "members": { - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.gamelift#PositiveInteger", + "m5a_24xlarge": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Length of time, in seconds, it takes for a new instance to start new game server\n processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly\n with game servers that take a long time to start up, because it avoids prematurely\n starting new instances.

" + "smithy.api#enumValue": "m5a.24xlarge" } }, - "TargetTrackingConfiguration": { - "target": "com.amazonaws.gamelift#TargetTrackingConfiguration", + "m6g_medium": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Settings for a target-based scaling policy applied to Auto Scaling group. These\n settings are used to create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Configuration settings for intelligent automatic scaling that uses target tracking.\n These settings are used to add an Auto Scaling policy when creating the corresponding\n Auto Scaling group with CreateGameServerGroup. After the Auto Scaling\n group is created, all updates to Auto Scaling policies, including changing this policy\n and adding or removing other policies, is done directly on the Auto Scaling group.

" - } - }, - "com.amazonaws.gamelift#GameServerGroupDeleteOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SAFE_DELETE", - "name": "SAFE_DELETE" - }, - { - "value": "FORCE_DELETE", - "name": "FORCE_DELETE" - }, - { - "value": "RETAIN", - "name": "RETAIN" + }, + "m6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.large" } - ] - } - }, - "com.amazonaws.gamelift#GameServerGroupInstanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "c4.large", - "name": "c4_large" - }, - { - "value": "c4.xlarge", - "name": "c4_xlarge" - }, - { - "value": "c4.2xlarge", - "name": "c4_2xlarge" - }, - { - "value": "c4.4xlarge", - "name": "c4_4xlarge" - }, - { - "value": "c4.8xlarge", - "name": "c4_8xlarge" - }, - { - "value": "c5.large", - "name": "c5_large" - }, - { - "value": "c5.xlarge", - "name": "c5_xlarge" - }, - { - "value": "c5.2xlarge", - "name": "c5_2xlarge" - }, - { - "value": "c5.4xlarge", - "name": "c5_4xlarge" - }, - { - "value": "c5.9xlarge", - "name": "c5_9xlarge" - }, - { - "value": "c5.12xlarge", - "name": "c5_12xlarge" - }, - { - "value": "c5.18xlarge", - "name": "c5_18xlarge" - }, - { - "value": "c5.24xlarge", - "name": "c5_24xlarge" - }, - { - "value": "c5a.large", - "name": "c5a_large" - }, - { - "value": "c5a.xlarge", - "name": "c5a_xlarge" - }, - { - "value": "c5a.2xlarge", - "name": "c5a_2xlarge" - }, - { - "value": "c5a.4xlarge", - "name": "c5a_4xlarge" - }, - { - "value": "c5a.8xlarge", - "name": "c5a_8xlarge" - }, - { - "value": "c5a.12xlarge", - "name": "c5a_12xlarge" - }, - { - "value": "c5a.16xlarge", - "name": "c5a_16xlarge" - }, - { - "value": "c5a.24xlarge", - "name": "c5a_24xlarge" - }, - { - "value": "c6g.medium", - "name": "c6g_medium" - }, - { - "value": "c6g.large", - "name": "c6g_large" - }, - { - "value": "c6g.xlarge", - "name": "c6g_xlarge" - }, - { - "value": "c6g.2xlarge", - "name": "c6g_2xlarge" - }, - { - "value": "c6g.4xlarge", - "name": "c6g_4xlarge" - }, - { - "value": "c6g.8xlarge", - "name": "c6g_8xlarge" - }, - { - "value": "c6g.12xlarge", - "name": "c6g_12xlarge" - }, - { - "value": "c6g.16xlarge", - "name": "c6g_16xlarge" - }, - { - "value": "r4.large", - "name": "r4_large" - }, - { - "value": "r4.xlarge", - "name": "r4_xlarge" - }, - { - "value": "r4.2xlarge", - "name": "r4_2xlarge" - }, - { - "value": "r4.4xlarge", - "name": "r4_4xlarge" - }, - { - "value": "r4.8xlarge", - "name": "r4_8xlarge" - }, - { - "value": "r4.16xlarge", - "name": "r4_16xlarge" - }, - { - "value": "r5.large", - "name": "r5_large" - }, - { - "value": "r5.xlarge", - "name": "r5_xlarge" - }, - { - "value": "r5.2xlarge", - "name": "r5_2xlarge" - }, - { - "value": "r5.4xlarge", - "name": "r5_4xlarge" - }, - { - "value": "r5.8xlarge", - "name": "r5_8xlarge" - }, - { - "value": "r5.12xlarge", - "name": "r5_12xlarge" - }, - { - "value": "r5.16xlarge", - "name": "r5_16xlarge" - }, - { - "value": "r5.24xlarge", - "name": "r5_24xlarge" - }, - { - "value": "r5a.large", - "name": "r5a_large" - }, - { - "value": "r5a.xlarge", - "name": "r5a_xlarge" - }, - { - "value": "r5a.2xlarge", - "name": "r5a_2xlarge" - }, - { - "value": "r5a.4xlarge", - "name": "r5a_4xlarge" - }, - { - "value": "r5a.8xlarge", - "name": "r5a_8xlarge" - }, - { - "value": "r5a.12xlarge", - "name": "r5a_12xlarge" - }, - { - "value": "r5a.16xlarge", - "name": "r5a_16xlarge" - }, - { - "value": "r5a.24xlarge", - "name": "r5a_24xlarge" - }, - { - "value": "r6g.medium", - "name": "r6g_medium" - }, - { - "value": "r6g.large", - "name": "r6g_large" - }, - { - "value": "r6g.xlarge", - "name": "r6g_xlarge" - }, - { - "value": "r6g.2xlarge", - "name": "r6g_2xlarge" - }, - { - "value": "r6g.4xlarge", - "name": "r6g_4xlarge" - }, - { - "value": "r6g.8xlarge", - "name": "r6g_8xlarge" - }, - { - "value": "r6g.12xlarge", - "name": "r6g_12xlarge" - }, - { - "value": "r6g.16xlarge", - "name": "r6g_16xlarge" - }, - { - "value": "m4.large", - "name": "m4_large" - }, - { - "value": "m4.xlarge", - "name": "m4_xlarge" - }, - { - "value": "m4.2xlarge", - "name": "m4_2xlarge" - }, - { - "value": "m4.4xlarge", - "name": "m4_4xlarge" - }, - { - "value": "m4.10xlarge", - "name": "m4_10xlarge" - }, - { - "value": "m5.large", - "name": "m5_large" - }, - { - "value": "m5.xlarge", - "name": "m5_xlarge" - }, - { - "value": "m5.2xlarge", - "name": "m5_2xlarge" - }, - { - "value": "m5.4xlarge", - "name": "m5_4xlarge" - }, - { - "value": "m5.8xlarge", - "name": "m5_8xlarge" - }, - { - "value": "m5.12xlarge", - "name": "m5_12xlarge" - }, - { - "value": "m5.16xlarge", - "name": "m5_16xlarge" - }, - { - "value": "m5.24xlarge", - "name": "m5_24xlarge" - }, - { - "value": "m5a.large", - "name": "m5a_large" - }, - { - "value": "m5a.xlarge", - "name": "m5a_xlarge" - }, - { - "value": "m5a.2xlarge", - "name": "m5a_2xlarge" - }, - { - "value": "m5a.4xlarge", - "name": "m5a_4xlarge" - }, - { - "value": "m5a.8xlarge", - "name": "m5a_8xlarge" - }, - { - "value": "m5a.12xlarge", - "name": "m5a_12xlarge" - }, - { - "value": "m5a.16xlarge", - "name": "m5a_16xlarge" - }, - { - "value": "m5a.24xlarge", - "name": "m5a_24xlarge" - }, - { - "value": "m6g.medium", - "name": "m6g_medium" - }, - { - "value": "m6g.large", - "name": "m6g_large" - }, - { - "value": "m6g.xlarge", - "name": "m6g_xlarge" - }, - { - "value": "m6g.2xlarge", - "name": "m6g_2xlarge" - }, - { - "value": "m6g.4xlarge", - "name": "m6g_4xlarge" - }, - { - "value": "m6g.8xlarge", - "name": "m6g_8xlarge" - }, - { - "value": "m6g.12xlarge", - "name": "m6g_12xlarge" - }, - { - "value": "m6g.16xlarge", - "name": "m6g_16xlarge" + }, + "m6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.xlarge" + } + }, + "m6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.2xlarge" + } + }, + "m6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.4xlarge" + } + }, + "m6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.8xlarge" + } + }, + "m6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.12xlarge" + } + }, + "m6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.16xlarge" } - ] + } } }, "com.amazonaws.gamelift#GameServerGroupName": { @@ -6792,38 +9107,50 @@ } }, "com.amazonaws.gamelift#GameServerGroupStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NEW", - "name": "NEW" - }, - { - "value": "ACTIVATING", - "name": "ACTIVATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETE_SCHEDULED", - "name": "DELETE_SCHEDULED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "ERROR", - "name": "ERROR" + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETE_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_SCHEDULED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" } - ] + } } }, "com.amazonaws.gamelift#GameServerGroups": { @@ -6833,14 +9160,14 @@ } }, "com.amazonaws.gamelift#GameServerHealthCheck": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HEALTHY", - "name": "HEALTHY" + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" } - ] + } } }, "com.amazonaws.gamelift#GameServerId": { @@ -6859,13 +9186,13 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { - "smithy.api#documentation": "

A developer-defined identifier for the game server group that includes the game\n server instance. The name is unique for each Region in each Amazon Web Services account.

" + "smithy.api#documentation": "

A developer-defined identifier for the game server group that includes the game server\n instance. The name is unique for each Region in each Amazon Web Services account.

" } }, "GameServerGroupArn": { "target": "com.amazonaws.gamelift#GameServerGroupArn", "traits": { - "smithy.api#documentation": "

A generated unique identifier for the game server group that includes the game\n server instance.

" + "smithy.api#documentation": "

A generated unique identifier for the game server group that includes the game server\n instance.

" } }, "InstanceId": { @@ -6877,12 +9204,12 @@ "InstanceStatus": { "target": "com.amazonaws.gamelift#GameServerInstanceStatus", "traits": { - "smithy.api#documentation": "

\n Current status of the game server instance. \n

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

Current status of the game server instance

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Additional properties, including status, that describe an EC2 instance in a game\n server group. Instance configurations are set with game server group properties (see\n DescribeGameServerGroup and with the EC2 launch template that was used\n when creating the game server group.

\n

Retrieve game server instances for a game server group by calling\n DescribeGameServerInstances.

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Additional properties,\n including status, that describe an EC2 instance in a game server group. Instance\n configurations are set with game server group properties (see\n DescribeGameServerGroup and with the EC2 launch template that was used\n when creating the game server group.

\n

Retrieve game server instances for a game server group by calling\n DescribeGameServerInstances.

" } }, "com.amazonaws.gamelift#GameServerInstanceId": { @@ -6908,22 +9235,26 @@ } }, "com.amazonaws.gamelift#GameServerInstanceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DRAINING", - "name": "DRAINING" - }, - { - "value": "SPOT_TERMINATING", - "name": "SPOT_TERMINATING" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAINING" } - ] + }, + "SPOT_TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT_TERMINATING" + } + } } }, "com.amazonaws.gamelift#GameServerInstances": { @@ -6933,33 +9264,37 @@ } }, "com.amazonaws.gamelift#GameServerProtectionPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NO_PROTECTION", - "name": "NO_PROTECTION" - }, - { - "value": "FULL_PROTECTION", - "name": "FULL_PROTECTION" + "type": "enum", + "members": { + "NO_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PROTECTION" + } + }, + "FULL_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_PROTECTION" } - ] + } } }, "com.amazonaws.gamelift#GameServerUtilizationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "UTILIZED", - "name": "UTILIZED" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UTILIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTILIZED" } - ] + } } }, "com.amazonaws.gamelift#GameServers": { @@ -6992,7 +9327,7 @@ "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on. \n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.\n

" } }, "CreationTime": { @@ -7034,7 +9369,7 @@ "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data\n with SearchGameSessions.

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).

" } }, "IpAddress": { @@ -7064,19 +9399,19 @@ "CreatorId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one\n exists), that limits the number of game sessions a player can create.

" + "smithy.api#documentation": "

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists),\n that limits the number of game sessions a player can create.

" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#LargeGameSessionData", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session).

" } }, "MatchmakerData": { "target": "com.amazonaws.gamelift#MatchmakerData", "traits": { - "smithy.api#documentation": "

Information about the matchmaking process that was used to create the game session.\n It is in JSON syntax, formatted as a string. In addition the matchmaking configuration\n used, it contains data on all players assigned to the match, including player attributes\n and team assignments. For more details on matchmaker data, see Match\n Data. Matchmaker data is useful when requesting match backfills, and is\n updated whenever new players are added during a successful backfill (see \n StartMatchBackfill).

" + "smithy.api#documentation": "

Information about the matchmaking process that was used to create the game session. It\n is in JSON syntax, formatted as a string. In addition the matchmaking configuration\n used, it contains data on all players assigned to the match, including player attributes\n and team assignments. For more details on matchmaker data, see Match\n Data. Matchmaker data is useful when requesting match backfills, and is\n updated whenever new players are added during a successful backfill (see StartMatchBackfill).

" } }, "Location": { @@ -7087,13 +9422,12 @@ } }, "traits": { - "smithy.api#documentation": "

Properties describing a game session.

\n

A game session in ACTIVE status can host players. When a game session ends, its\n status is set to TERMINATED.

\n

Once the session ends, the game session object is retained for 30 days. This means\n you can reuse idempotency token values after this time. Game session logs are retained\n for 14 days.

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Properties describing a game session.

\n

A game session in ACTIVE status can host players. When a game session ends, its status\n is set to TERMINATED.

\n

Once the session ends, the game session object is retained for 30 days. This means you\n can reuse idempotency token values after this time. Game session logs are retained for\n 14 days.

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#GameSessionActivationTimeoutSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 600 @@ -7110,7 +9444,7 @@ } }, "IpAddress": { - "target": "com.amazonaws.gamelift#StringModel", + "target": "com.amazonaws.gamelift#IpAddress", "traits": { "smithy.api#documentation": "

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

" } @@ -7135,7 +9469,7 @@ } }, "traits": { - "smithy.api#documentation": "

Connection information for a new game session that is created in response to a StartMatchmaking request. Once a match is made, the FlexMatch engine\n creates a new game session for it. This information, including the game session endpoint\n and player sessions for each player in the original matchmaking request, is added to the\n MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.

" + "smithy.api#documentation": "

Connection information for a new game session that is created in response to a start\n matchmaking request. Once a match is made, the FlexMatch engine creates a new game session\n for it. This information, including the game session endpoint and player sessions for\n each player in the original matchmaking request, is added to the matchmaking\n ticket.

" } }, "com.amazonaws.gamelift#GameSessionData": { @@ -7159,12 +9493,12 @@ "ProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "

Current status of protection for the game session.

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

Current status of protection for the game session.

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

A game session's properties plus the protection policy currently in\n force.

" + "smithy.api#documentation": "

A game session's properties plus the protection policy currently in force.

" } }, "com.amazonaws.gamelift#GameSessionDetailList": { @@ -7181,7 +9515,7 @@ } }, "traits": { - "smithy.api#documentation": "

The game instance is currently full and cannot allow the requested player(s) to\n join. Clients can retry such requests immediately or after a waiting period.

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

The game instance is currently full and cannot allow the requested player(s) to join.\n Clients can retry such requests immediately or after a waiting period.

", "smithy.api#error": "client" } }, @@ -7209,13 +9543,13 @@ "Status": { "target": "com.amazonaws.gamelift#GameSessionPlacementState", "traits": { - "smithy.api#documentation": "

Current status of the game session placement request.

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

Current status of the game session placement request.

\n " } }, "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).

" } }, "MaximumPlayerSessionCount": { @@ -7233,25 +9567,25 @@ "GameSessionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for the game session. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

A unique identifier for the game session. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, "GameSessionArn": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Identifier for the game session created by this placement request. This value is\n set once the new game session is placed (placement status is FULFILLED).\n This identifier is unique across all Regions. You can use this value as a\n GameSessionId value as needed.

" + "smithy.api#documentation": "

Identifier for the game session created by this placement request. This value is set\n once the new game session is placed (placement status is FULFILLED). This\n identifier is unique across all Regions. You can use this value as a\n GameSessionId value as needed.

" } }, "GameSessionRegion": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Name of the Region where the game session created by this placement request is\n running. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

Name of the Region where the game session created by this placement request is\n running. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, "PlayerLatencies": { "target": "com.amazonaws.gamelift#PlayerLatencyList", "traits": { - "smithy.api#documentation": "

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions.

" + "smithy.api#documentation": "

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.

" } }, "StartTime": { @@ -7263,13 +9597,13 @@ "EndTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this request was completed, canceled, or timed\n out.

" + "smithy.api#documentation": "

Time stamp indicating when this request was completed, canceled, or timed out.

" } }, "IpAddress": { "target": "com.amazonaws.gamelift#IpAddress", "traits": { - "smithy.api#documentation": "

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, "DnsName": { @@ -7281,57 +9615,65 @@ "Port": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#documentation": "

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, "PlacedPlayerSessions": { "target": "com.amazonaws.gamelift#PlacedPlayerSessionList", "traits": { - "smithy.api#documentation": "

A collection of information on player sessions created in response to the game\n session placement request. These player sessions are created only once a new game\n session is successfully placed (placement status is FULFILLED). This\n information includes the player ID (as provided in the placement request) and the\n corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

" + "smithy.api#documentation": "

A collection of information on player sessions created in response to the game session\n placement request. These player sessions are created only once a new game session is\n successfully placed (placement status is FULFILLED). This information\n includes the player ID (as provided in the placement request) and the corresponding\n player session ID.

" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#LargeGameSessionData", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, "MatchmakerData": { "target": "com.amazonaws.gamelift#MatchmakerData", "traits": { - "smithy.api#documentation": "

Information on the matchmaking process for this game. Data is in JSON syntax,\n formatted as a string. It identifies the matchmaking configuration used to create the\n match, and contains data on all players assigned to the match, including player\n attributes and team assignments. For more details on matchmaker data, see Match\n Data.

" + "smithy.api#documentation": "

Information on the matchmaking process for this game. Data is in JSON syntax,\n formatted as a string. It identifies the matchmaking configuration used to create the\n match, and contains data on all players assigned to the match, including player\n attributes and team assignments. For more details on matchmaker data, see Match\n Data.

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

Object that describes a StartGameSessionPlacement request. This\n object includes the full details of the original request plus the current status and\n start/end time stamps.

\n

Game session placement-related operations include:

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

This object includes the full details of the original request plus the current status\n and start/end time stamps.

" } }, "com.amazonaws.gamelift#GameSessionPlacementState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "FULFILLED", - "name": "FULFILLED" - }, - { - "value": "CANCELLED", - "name": "CANCELLED" - }, - { - "value": "TIMED_OUT", - "name": "TIMED_OUT" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "FULFILLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULFILLED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.gamelift#GameSessionQueue": { @@ -7346,7 +9688,7 @@ "GameSessionQueueArn": { "target": "com.amazonaws.gamelift#GameSessionQueueArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. In a GameLift game session queue ARN, the resource ID matches the\n Name value.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. In a GameLift game session queue ARN, the resource ID matches the\n Name value.

" } }, "TimeoutInSeconds": { @@ -7382,18 +9724,18 @@ "CustomEventData": { "target": "com.amazonaws.gamelift#QueueCustomEventData", "traits": { - "smithy.api#documentation": "

\n Information that is added to all events that are related to this game session queue.\n

" + "smithy.api#documentation": "

Information that is added to all events that are related to this game session\n queue.

" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#QueueSnsArnStringModel", "traits": { - "smithy.api#documentation": "

An SNS topic ARN that is set up to receive game session placement notifications. See \n Setting up notifications for game session placement.

" + "smithy.api#documentation": "

An SNS topic ARN that is set up to receive game session placement notifications. See\n Setting up\n notifications for game session placement.

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

Configuration for a game session placement mechanism that processes requests for new\n game sessions. A queue can be used on its own or as part of a matchmaking\n solution.

\n

\n Related actions\n

\n

\n CreateGameSessionQueue\n | \n DescribeGameSessionQueues\n | \n UpdateGameSessionQueue\n

" + "smithy.api#documentation": "

Configuration for a game session placement mechanism that processes requests for new\n game sessions. A queue can be used on its own or as part of a matchmaking\n solution.

" } }, "com.amazonaws.gamelift#GameSessionQueueArn": { @@ -7406,94 +9748,268 @@ "smithy.api#pattern": "^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+$" } }, - "com.amazonaws.gamelift#GameSessionQueueDestination": { + "com.amazonaws.gamelift#GameSessionQueueDestination": { + "type": "structure", + "members": { + "DestinationArn": { + "target": "com.amazonaws.gamelift#ArnStringModel", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which\n include a fleet ID or alias ID and a Region name, provide a unique identifier across all\n Regions.

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

A fleet or alias designated in a game session queue. Queues fulfill requests for new\n game sessions by placing a new game session on any of the queue's destinations.

" + } + }, + "com.amazonaws.gamelift#GameSessionQueueDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#GameSessionQueueDestination" + } + }, + "com.amazonaws.gamelift#GameSessionQueueList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#GameSessionQueue" + } + }, + "com.amazonaws.gamelift#GameSessionQueueName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.gamelift#GameSessionQueueNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+|^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.gamelift#GameSessionQueueNameOrArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArn" + } + }, + "com.amazonaws.gamelift#GameSessionStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.gamelift#GameSessionStatusReason": { + "type": "enum", + "members": { + "INTERRUPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERRUPTED" + } + } + } + }, + "com.amazonaws.gamelift#GetComputeAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#GetComputeAccessInput" + }, + "output": { + "target": "com.amazonaws.gamelift#GetComputeAccessOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Requests remote access to a fleet instance. Remote access is useful for debugging,\n gathering benchmarking data, or observing activity in real time.

\n

To remotely access an instance, you need credentials that match the operating system\n of the instance. For a Windows instance, GameLift returns a user name and password as\n strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift\n returns a user name and RSA private key, also as strings, for use with an SSH client.\n The private key must be saved in the proper format to a .pem file before\n using. If you're making this request using the CLI, saving the secret can be handled\n as part of the GetInstanceAccess request, as shown in one of the examples\n for this operation.

\n

To request access to a specific instance, specify the IDs of both the instance and the\n fleet it belongs to.

\n

\n Learn more\n

\n

\n Remotely Access Fleet\n Instances\n

\n

\n Debug Fleet\n Issues\n

" + } + }, + "com.amazonaws.gamelift#GetComputeAccessInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet that the compute resource is registered to.

", + "smithy.api#required": {} + } + }, + "ComputeName": { + "target": "com.amazonaws.gamelift#ComputeNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the compute resource you are requesting credentials for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.gamelift#GetComputeAccessOutput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

The fleet ID of compute resource.

" + } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + } + }, + "ComputeName": { + "target": "com.amazonaws.gamelift#ComputeNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the compute resource you requested credentials for.

" + } + }, + "ComputeArn": { + "target": "com.amazonaws.gamelift#ComputeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + } + }, + "Credentials": { + "target": "com.amazonaws.gamelift#AwsCredentials", + "traits": { + "smithy.api#documentation": "

The access credentials for the compute resource.

" + } + } + } + }, + "com.amazonaws.gamelift#GetComputeAuthToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#GetComputeAuthTokenInput" + }, + "output": { + "target": "com.amazonaws.gamelift#GetComputeAuthTokenOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Requests an authorization token from GameLift. The authorization token is used by your\n game server to authenticate with GameLift. Each authentication token has an expiration\n token. To continue using the compute resource to host your game server, regularly\n retrieve a new authorization token.

" + } + }, + "com.amazonaws.gamelift#GetComputeAuthTokenInput": { "type": "structure", "members": { - "DestinationArn": { - "target": "com.amazonaws.gamelift#ArnStringModel", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet that the compute is registered to.

", + "smithy.api#required": {} + } + }, + "ComputeName": { + "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which\n include a fleet ID or alias ID and a Region name, provide a unique identifier across all\n Regions.

" + "smithy.api#documentation": "

The name of the compute resource you are requesting the authorization token\n for.

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

A fleet or alias designated in a game session queue. Queues fulfill requests for new\n game sessions by placing a new game session on any of the queue's destinations.

\n

Destinations are part of a GameSessionQueue.

" - } - }, - "com.amazonaws.gamelift#GameSessionQueueDestinationList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#GameSessionQueueDestination" - } - }, - "com.amazonaws.gamelift#GameSessionQueueList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#GameSessionQueue" } }, - "com.amazonaws.gamelift#GameSessionQueueName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 + "com.amazonaws.gamelift#GetComputeAuthTokenOutput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet that the compute is registered to.

" + } }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.gamelift#GameSessionQueueNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + } }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+|^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.gamelift#GameSessionQueueNameOrArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArn" - } - }, - "com.amazonaws.gamelift#GameSessionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "ACTIVATING", - "name": "ACTIVATING" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" - }, - { - "value": "TERMINATING", - "name": "TERMINATING" - }, - { - "value": "ERROR", - "name": "ERROR" + "ComputeName": { + "target": "com.amazonaws.gamelift#ComputeNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the compute resource you are requesting the authorization token\n for.

" } - ] - } - }, - "com.amazonaws.gamelift#GameSessionStatusReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INTERRUPTED", - "name": "INTERRUPTED" + }, + "ComputeArn": { + "target": "com.amazonaws.gamelift#ComputeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912\n

" + } + }, + "AuthToken": { + "target": "com.amazonaws.gamelift#ComputeAuthToken", + "traits": { + "smithy.api#documentation": "

The authorization token that your game server uses to authenticate with\n GameLift.

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

The amount of time until the authorization token is no longer valid. To continue using\n the compute resource for game server hosting, renew the authorization token by using\n this operation again.

" } - ] + } } }, "com.amazonaws.gamelift#GetGameSessionLogUrl": { @@ -7519,7 +10035,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the location of stored game session logs for a specified game session.\n When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and\n retains them for 14 days. Use this URL to download the logs.

\n \n

See the Amazon Web Services Service\n Limits page for maximum log file sizes. Log files that exceed this limit\n are not saved.

\n \n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves the location of stored game session logs for a specified game session. When\n a game session is terminated, GameLift automatically stores the logs in Amazon S3 and\n retains them for 14 days. Use this URL to download the logs.

\n \n

See the Amazon Web Services Service\n Limits page for maximum log file sizes. Log files that exceed this limit\n are not saved.

\n \n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#GetGameSessionLogUrlInput": { @@ -7532,9 +10048,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#GetGameSessionLogUrlOutput": { @@ -7543,12 +10056,9 @@ "PreSignedUrl": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Location of the requested game session logs, available for download. This URL is\n valid for 15 minutes, after which S3 will reject any download request using this URL.\n You can request a new URL any time within the 14-day period that the logs are\n retained.

" + "smithy.api#documentation": "

Location of the requested game session logs, available for download. This URL is valid\n for 15 minutes, after which S3 will reject any download request using this URL. You can\n request a new URL any time within the 14-day period that the logs are retained.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#GetInstanceAccess": { @@ -7574,7 +10084,7 @@ } ], "traits": { - "smithy.api#documentation": "

Requests remote access to a fleet instance. Remote access is useful for debugging,\n gathering benchmarking data, or observing activity in real time.

\n

To remotely access an instance, you need credentials that match the operating system\n of the instance. For a Windows instance, GameLift returns a user name and password as\n strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift\n returns a user name and RSA private key, also as strings, for use with an SSH client.\n The private key must be saved in the proper format to a .pem file before\n using. If you're making this request using the CLI, saving the secret can be handled\n as part of the GetInstanceAccess request, as shown in one of the examples\n for this operation.

\n

To request access to a specific instance, specify the IDs of both the instance and the\n fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess\n object is returned that contains the instance's IP address and a set of\n credentials.

\n

\n Learn more\n

\n

\n Remotely Access Fleet\n Instances\n

\n

\n Debug Fleet\n Issues\n

\n \n

\n Related actions\n

\n

\n DescribeInstances | \n GetInstanceAccess | \n DescribeEC2InstanceLimits | \n All APIs by task\n

" + "smithy.api#documentation": "

Requests remote access to a fleet instance. Remote access is useful for debugging,\n gathering benchmarking data, or observing activity in real time.

\n

To remotely access an instance, you need credentials that match the operating system\n of the instance. For a Windows instance, GameLift returns a user name and password as\n strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift\n returns a user name and RSA private key, also as strings, for use with an SSH client.\n The private key must be saved in the proper format to a .pem file before\n using. If you're making this request using the CLI, saving the secret can be handled\n as part of the GetInstanceAccess request, as shown in one of the examples\n for this operation.

\n

To request access to a specific instance, specify the IDs of both the instance and the\n fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances.

\n

\n Learn more\n

\n

\n Remotely Access Fleet\n Instances\n

\n

\n Debug Fleet\n Issues\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#GetInstanceAccessInput": { @@ -7590,13 +10100,10 @@ "InstanceId": { "target": "com.amazonaws.gamelift#InstanceId", "traits": { - "smithy.api#documentation": "

A unique identifier for the instance you want to get access to. You can access an instance in any\n status.

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

A unique identifier for the instance you want to get access to. You can access an instance in any status.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#GetInstanceAccessOutput": { @@ -7605,12 +10112,9 @@ "InstanceAccess": { "target": "com.amazonaws.gamelift#InstanceAccess", "traits": { - "smithy.api#documentation": "

The connection information for a fleet instance, including IP\n address and access credentials.

" + "smithy.api#documentation": "

The connection information for a fleet instance, including IP address and access\n credentials.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#IamRoleArn": { @@ -7641,7 +10145,7 @@ } }, "traits": { - "smithy.api#documentation": "

A game session with this custom ID string already exists in this fleet. Resolve\n this conflict before retrying this request.

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

A game session with this custom ID string already exists in this fleet. Resolve this\n conflict before retrying this request.

", "smithy.api#error": "client" } }, @@ -7687,13 +10191,13 @@ "Type": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "

Amazon EC2 instance type that defines the computing resources of this instance.\n

" + "smithy.api#documentation": "

Amazon EC2 instance type that defines the computing resources of this instance.

" } }, "Status": { "target": "com.amazonaws.gamelift#InstanceStatus", "traits": { - "smithy.api#documentation": "

Current status of the instance. Possible statuses include the following:

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

Current status of the instance. Possible statuses include the following:

\n " } }, "CreationTime": { @@ -7705,12 +10209,12 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The fleet location of the instance, expressed as an Amazon Web Services Region\n code, such as us-west-2.

" + "smithy.api#documentation": "

The fleet location of the instance, expressed as an Amazon Web Services Region code, such as\n us-west-2.

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

Represents an EC2 instance of virtual computing resources that hosts one or more game\n servers. In GameLift, a fleet can contain zero or more instances.

\n

\n Related actions\n

\n

\n DescribeInstances\n

" + "smithy.api#documentation": "

Represents an EC2 instance of virtual computing resources that hosts one or more game\n servers. In GameLift, a fleet can contain zero or more instances.

\n

\n Related actions\n

" } }, "com.amazonaws.gamelift#InstanceAccess": { @@ -7748,7 +10252,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information required to remotely connect to a fleet instance. Access is requested\n by calling GetInstanceAccess.

" + "smithy.api#documentation": "

Information required to remotely connect to a fleet instance.

" } }, "com.amazonaws.gamelift#InstanceCredentials": { @@ -7763,12 +10267,12 @@ "Secret": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Secret string. For Windows instances, the secret is a password for use with Windows\n Remote Desktop. For Linux instances, it is a private key (which must be saved as a\n .pem file) for use with SSH.

" + "smithy.api#documentation": "

Secret string. For Windows instances, the secret is a password for use with Windows\n Remote Desktop. For Linux instances, it is a private key (which must be saved as a\n .pem file) for use with SSH.

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

Set of credentials required to remotely access a fleet instance. Access credentials\n are requested by calling GetInstanceAccess and returned in an InstanceAccess object.

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

Set of credentials required to remotely access a fleet instance.

", "smithy.api#sensitive": {} } }, @@ -7790,7 +10294,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

An allowed instance type for a GameServerGroup. All game server groups must have at least two\n instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type\n for viability. It then updates the Auto Scaling group with the list of viable instance\n types.

" + "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

An allowed instance type for a\n game server group. All game server groups must have at least two instance types defined\n for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then\n updates the Auto Scaling group with the list of viable instance types.

" } }, "com.amazonaws.gamelift#InstanceDefinitions": { @@ -7818,26 +10322,33 @@ } }, "com.amazonaws.gamelift#InstanceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "TERMINATING", - "name": "TERMINATING" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" } - ] + } } }, "com.amazonaws.gamelift#Integer": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.gamelift#InternalServiceException": { "type": "structure", @@ -7847,7 +10358,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service encountered an unrecoverable internal failure while processing the\n request. Clients can retry such requests immediately or after a waiting\n period.

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

The service encountered an unrecoverable internal failure while processing the\n request. Clients can retry such requests immediately or after a waiting period.

", "smithy.api#error": "server" } }, @@ -7883,7 +10394,7 @@ } }, "traits": { - "smithy.api#documentation": "

One or more parameter values in the request are invalid. Correct the invalid\n parameter values before retrying.

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

One or more parameter values in the request are invalid. Correct the invalid parameter\n values before retrying.

", "smithy.api#error": "client" } }, @@ -7894,7 +10405,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$" + "smithy.api#pattern": "^[0-9A-Fa-f\\:\\.]+$" } }, "com.amazonaws.gamelift#IpPermission": { @@ -7930,7 +10441,7 @@ } }, "traits": { - "smithy.api#documentation": "

A range of IP addresses and port settings that allow inbound traffic to connect to\n server processes on an instance in a fleet. New game sessions are assigned an IP\n address/port number combination, which must fall into the fleet's allowed ranges. Fleets\n with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift\n automatically opens two port ranges, one for TCP messaging and one for UDP.

\n

\n Related actions\n

\n

\n DescribeFleetPortSettings\n

" + "smithy.api#documentation": "

A range of IP addresses and port settings that allow inbound traffic to connect to\n server processes on an instance in a fleet. New game sessions are assigned an IP\n address/port number combination, which must fall into the fleet's allowed ranges. Fleets\n with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift\n automatically opens two port ranges, one for TCP messaging and one for UDP.

" } }, "com.amazonaws.gamelift#IpPermissionsList": { @@ -7946,18 +10457,20 @@ } }, "com.amazonaws.gamelift#IpProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TCP", - "name": "TCP" - }, - { - "value": "UDP", - "name": "UDP" + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UDP" } - ] + } } }, "com.amazonaws.gamelift#LargeGameSessionData": { @@ -8036,12 +10549,12 @@ "Version": { "target": "com.amazonaws.gamelift#LaunchTemplateVersion", "traits": { - "smithy.api#documentation": "

The version of the Amazon EC2 launch template to use. If no version is specified, the\n default version will be used. With Amazon EC2, you can specify a default version for a\n launch template. If none is set, the default is the first version created.

" + "smithy.api#documentation": "

The version of the Amazon EC2 launch template to use. If no version is specified, the\n default version will be used. With Amazon EC2, you can specify a default version for a launch\n template. If none is set, the default is the first version created.

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

An Amazon Elastic Compute Cloud launch template that contains configuration settings and game server code to\n be deployed to all instances in a game server group. The launch template is specified\n when creating a new game server group with CreateGameServerGroup.

" + "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

An Amazon Elastic Compute Cloud launch\n template that contains configuration settings and game server code to be deployed to all\n instances in a game server group. The launch template is specified when creating a new\n game server group.

" } }, "com.amazonaws.gamelift#LaunchTemplateVersion": { @@ -8062,7 +10575,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation would cause the resource to exceed the allowed service\n limit. Resolve the issue before retrying.

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

The requested operation would cause the resource to exceed the allowed service limit.\n Resolve the issue before retrying.

", "smithy.api#error": "client" } }, @@ -8086,7 +10599,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all aliases for this Amazon Web Services account. You can filter the result set by\n alias name and/or routing strategy type. Use the pagination parameters to retrieve\n results in sequential pages.

\n \n

Returned aliases are not listed in any particular order.

\n \n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

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

Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias\n name and/or routing strategy type. Use the pagination parameters to retrieve results in\n sequential pages.

\n \n

Returned aliases are not listed in any particular order.

\n \n

\n Related actions\n

\n

\n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8101,7 +10614,7 @@ "RoutingStrategyType": { "target": "com.amazonaws.gamelift#RoutingStrategyType", "traits": { - "smithy.api#documentation": "

The routing type to filter results on. Use this parameter to retrieve only aliases\n with a certain routing type. To retrieve all aliases, leave this parameter empty.

\n

Possible routing types include the following:

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

The routing type to filter results on. Use this parameter to retrieve only aliases\n with a certain routing type. To retrieve all aliases, leave this parameter empty.

\n

Possible routing types include the following:

\n " } }, "Name": { @@ -8122,9 +10635,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ListAliasesOutput": { @@ -8142,9 +10652,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ListBuilds": { @@ -8167,7 +10674,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves build resources for all builds associated with the Amazon Web Services account in use. You\n can limit results to builds that are in a specific status by using the\n Status parameter. Use the pagination parameters to retrieve results in\n a set of sequential pages.

\n \n

Build resources are not listed in any particular order.

\n \n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

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

Retrieves build resources for all builds associated with the Amazon Web Services account in use. You\n can limit results to builds that are in a specific status by using the\n Status parameter. Use the pagination parameters to retrieve results in\n a set of sequential pages.

\n \n

Build resources are not listed in any particular order.

\n \n

\n Learn more\n

\n

\n Upload a Custom\n Server Build\n

\n

\n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8197,9 +10704,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ListBuildsOutput": { @@ -8217,9 +10721,82 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } } + } + }, + "com.amazonaws.gamelift#ListCompute": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#ListComputeInput" }, + "output": { + "target": "com.amazonaws.gamelift#ListComputeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" + "smithy.api#documentation": "

Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ComputeList", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.gamelift#ListComputeInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet the compute resources are registered to.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.gamelift#LocationStringModel", + "traits": { + "smithy.api#documentation": "

The name of the custom location that the compute resources are assigned to.

" + } + }, + "Limit": { + "target": "com.amazonaws.gamelift#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

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

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" + } + } + } + }, + "com.amazonaws.gamelift#ListComputeOutput": { + "type": "structure", + "members": { + "ComputeList": { + "target": "com.amazonaws.gamelift#ComputeList", + "traits": { + "smithy.api#documentation": "

A list of compute resources registered to the fleet you specified.

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

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" + } + } } }, "com.amazonaws.gamelift#ListFleets": { @@ -8245,7 +10822,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation\n to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your\n request. You can filter the result set to find only those fleets that are deployed with\n a specific build or script. For fleets that have multiple locations, this operation\n retrieves fleets based on their home Region only.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a list of fleet IDs that match the request parameters is returned. A\n NextToken value is also returned if there are more result pages to retrieve.

\n \n

Fleet resources are not listed in a particular order.

\n \n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n

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

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this\n operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor\n specify a Region in your request. You can filter the result set to find only those\n fleets that are deployed with a specific build or script. For fleets that have multiple\n locations, this operation retrieves fleets based on their home Region only.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a list of fleet IDs that match the request parameters is returned. A\n NextToken value is also returned if there are more result pages to retrieve.

\n \n

Fleet resources are not listed in a particular order.

\n \n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8281,9 +10858,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ListFleetsOutput": { @@ -8292,7 +10866,7 @@ "FleetIds": { "target": "com.amazonaws.gamelift#FleetIdList", "traits": { - "smithy.api#documentation": "

A set of fleet IDs that match the list request. \n You can retrieve additional information about all \n returned fleets by passing this result set to a DescribeFleetAttributes, DescribeFleetCapacity, or\n DescribeFleetUtilization call.

" + "smithy.api#documentation": "

A set of fleet IDs that match the list request.

" } }, "NextToken": { @@ -8301,9 +10875,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ListGameServerGroups": { @@ -8326,7 +10897,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on all game servers groups that exist in the current Amazon Web Services\n account for the selected Region. Use the pagination parameters to retrieve results in a\n set of sequential segments.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

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

Lists a game server groups.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8338,6 +10909,82 @@ "com.amazonaws.gamelift#ListGameServerGroupsInput": { "type": "structure", "members": { + "Limit": { + "target": "com.amazonaws.gamelift#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The game server groups' limit.

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

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

" + } + } + } + }, + "com.amazonaws.gamelift#ListGameServerGroupsOutput": { + "type": "structure", + "members": { + "GameServerGroups": { + "target": "com.amazonaws.gamelift#GameServerGroups", + "traits": { + "smithy.api#documentation": "

The game server groups' game server groups.

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

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

" + } + } + } + }, + "com.amazonaws.gamelift#ListGameServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#ListGameServersInput" + }, + "output": { + "target": "com.amazonaws.gamelift#ListGameServersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on all game\n servers that are currently active in a specified game server group. You can opt to sort\n the list by game server age. Use the pagination parameters to retrieve results in a set\n of sequential segments.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GameServers", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.gamelift#ListGameServersInput": { + "type": "structure", + "members": { + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", + "traits": { + "smithy.api#documentation": "

An identifier for the game server group to retrieve a list of game servers from. Use\n either the name or ARN value.

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

Indicates how to sort the returned data based on game server registration timestamp.\n Use ASCENDING to retrieve oldest game servers first, or use\n DESCENDING to retrieve newest game servers first. If this parameter is\n left empty, game servers are returned in no particular order.

" + } + }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { @@ -8352,13 +10999,13 @@ } } }, - "com.amazonaws.gamelift#ListGameServerGroupsOutput": { + "com.amazonaws.gamelift#ListGameServersOutput": { "type": "structure", "members": { - "GameServerGroups": { - "target": "com.amazonaws.gamelift#GameServerGroups", + "GameServers": { + "target": "com.amazonaws.gamelift#GameServers", "traits": { - "smithy.api#documentation": "

A collection of game server group objects that match the request.

" + "smithy.api#documentation": "

A collection of game server objects that match the request.

" } }, "NextToken": { @@ -8369,13 +11016,13 @@ } } }, - "com.amazonaws.gamelift#ListGameServers": { + "com.amazonaws.gamelift#ListLocations": { "type": "operation", "input": { - "target": "com.amazonaws.gamelift#ListGameServersInput" + "target": "com.amazonaws.gamelift#ListLocationsInput" }, "output": { - "target": "com.amazonaws.gamelift#ListGameServersOutput" + "target": "com.amazonaws.gamelift#ListLocationsOutput" }, "errors": [ { @@ -8389,33 +11036,26 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on all game servers that are currently active in a specified\n game server group. You can opt to sort the list by game server age. Use the\n pagination parameters to retrieve results in a set of sequential segments.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n

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

Lists all custom and Amazon Web Services locations.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "GameServers", + "items": "Locations", "pageSize": "Limit" } } }, - "com.amazonaws.gamelift#ListGameServersInput": { + "com.amazonaws.gamelift#ListLocationsInput": { "type": "structure", "members": { - "GameServerGroupName": { - "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", - "traits": { - "smithy.api#documentation": "

An identifier for the game server group to retrieve a list of game servers from. \n Use either the GameServerGroup name or ARN value.

", - "smithy.api#required": {} - } - }, - "SortOrder": { - "target": "com.amazonaws.gamelift#SortOrder", + "Filters": { + "target": "com.amazonaws.gamelift#LocationFilterList", "traits": { - "smithy.api#documentation": "

Indicates how to sort the returned data based on game server registration timestamp.\n Use ASCENDING to retrieve oldest game servers first, or use\n DESCENDING to retrieve newest game servers first. If this parameter is\n left empty, game servers are returned in no particular order.

" + "smithy.api#documentation": "

Filters the list for AWS or CUSTOM locations.

" } }, "Limit": { - "target": "com.amazonaws.gamelift#PositiveInteger", + "target": "com.amazonaws.gamelift#ListLocationsLimit", "traits": { "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" } @@ -8428,13 +11068,22 @@ } } }, - "com.amazonaws.gamelift#ListGameServersOutput": { + "com.amazonaws.gamelift#ListLocationsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.gamelift#ListLocationsOutput": { "type": "structure", "members": { - "GameServers": { - "target": "com.amazonaws.gamelift#GameServers", + "Locations": { + "target": "com.amazonaws.gamelift#LocationModelList", "traits": { - "smithy.api#documentation": "

A collection of game server objects that match the request.

" + "smithy.api#documentation": "

A collection of locations.

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

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

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

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services\n account in use.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n All APIs by task\n

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

\n Retrieves all tags that are assigned to a GameLift resource. \n Resource tags are used to organize Amazon Web Services resources for a range of purposes. \n This operation handles the permissions necessary to manage tags for the following \n GameLift resource types:

\n \n

To list tags for a resource, specify the unique ARN value for the resource.

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to\n organize Amazon Web Services resources for a range of purposes. This operation handles the permissions\n necessary to manage tags for the following GameLift resource types:

\n \n

To list tags for a resource, specify the unique ARN value for the resource.

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#ListTagsForResourceRequest": { @@ -8540,7 +11189,7 @@ "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to retrieve\n tags for. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe operation for the resource type.

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

The Amazon Resource Name (ARN) that is assigned to and\n uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift\n resource ARNs are included in the data object for the resource, which can be retrieved\n by calling a List or Describe operation for the resource type.

", "smithy.api#required": {} } } @@ -8552,11 +11201,21 @@ "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { - "smithy.api#documentation": "

\n The collection of tags that have been assigned to the specified resource.\n

" + "smithy.api#documentation": "

The collection of tags that have been assigned to the specified resource.

" } } } }, + "com.amazonaws.gamelift#LocationArnModel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:.*:location\\/custom-\\S+$" + } + }, "com.amazonaws.gamelift#LocationAttributes": { "type": "structure", "members": { @@ -8575,12 +11234,12 @@ "UpdateStatus": { "target": "com.amazonaws.gamelift#LocationUpdateStatus", "traits": { - "smithy.api#documentation": "

The status of fleet activity updates to the location. The status\n PENDING_UPDATE indicates that StopFleetActions or StartFleetActions\n has been requested but the update has not yet been completed for the location.

" + "smithy.api#documentation": "

The status of fleet activity updates to the location. The status\n PENDING_UPDATE indicates that StopFleetActions or\n StartFleetActions has been requested but the update has not yet been\n completed for the location.

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

Represents a location in a multi-location fleet.

\n

\n Related actions\n

\n

\n DescribeFleetLocationAttributes \n

" + "smithy.api#documentation": "

Details about a location in a multi-location fleet.

" } }, "com.amazonaws.gamelift#LocationAttributesList": { @@ -8595,12 +11254,13 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

An Amazon Web Services Region code, such as us-west-2.

" + "smithy.api#documentation": "

An Amazon Web Services Region code, such as us-west-2.

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

A remote location where a multi-location fleet can deploy EC2 instances for game\n hosting.

\n

\n Related actions\n

\n

\n CreateFleet\n

" + "smithy.api#documentation": "

A remote location where a multi-location fleet can deploy EC2 instances for game\n hosting.

" } }, "com.amazonaws.gamelift#LocationConfigurationList": { @@ -8615,6 +11275,35 @@ } } }, + "com.amazonaws.gamelift#LocationFilter": { + "type": "enum", + "members": { + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.gamelift#LocationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#LocationFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.gamelift#LocationList": { "type": "list", "member": { @@ -8627,13 +11316,39 @@ } } }, + "com.amazonaws.gamelift#LocationModel": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.gamelift#LocationStringModel", + "traits": { + "smithy.api#documentation": "

The location's name.

" + } + }, + "LocationArn": { + "target": "com.amazonaws.gamelift#LocationArnModel", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift location resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

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

Properties of a location

" + } + }, + "com.amazonaws.gamelift#LocationModelList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#LocationModel" + } + }, "com.amazonaws.gamelift#LocationState": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.

" + "smithy.api#documentation": "

The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.\n

" } }, "Status": { @@ -8644,7 +11359,7 @@ } }, "traits": { - "smithy.api#documentation": "

A fleet location and its life-cycle state. A location state object might\n be used to describe a fleet's remote location or home Region.\n Life-cycle state tracks the progress of launching the first instance in a new \n location and preparing it for game hosting, and then removing all instances and\n deleting the location from the fleet.

\n

\n Related actions\n

\n

\n CreateFleet | \n CreateFleetLocations |\n DeleteFleetLocations\n

" + "smithy.api#documentation": "

A fleet location and its life-cycle state. A location state object might be used to\n describe a fleet's remote location or home Region. Life-cycle state tracks the progress\n of launching the first instance in a new location and preparing it for game hosting, and\n then removing all instances and deleting the location from the fleet.

\n " } }, "com.amazonaws.gamelift#LocationStateList": { @@ -8660,18 +11375,18 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-z]+(-([a-z]+|\\d))*$" + "smithy.api#pattern": "^[A-Za-z0-9\\-]+$" } }, "com.amazonaws.gamelift#LocationUpdateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_UPDATE", - "name": "PENDING_UPDATE" + "type": "enum", + "members": { + "PENDING_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_UPDATE" } - ] + } } }, "com.amazonaws.gamelift#MatchedPlayerSession": { @@ -8691,7 +11406,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a new player session that is created as a result of a successful FlexMatch\n match. A successful match automatically creates new player sessions for every player ID\n in the original matchmaking request.

\n

When players connect to the match's game session, they must include both player ID\n and player session ID in order to claim their assigned player slot.

" + "smithy.api#documentation": "

Represents a new player session that is created as a result of a successful FlexMatch\n match. A successful match automatically creates new player sessions for every player ID\n in the original matchmaking request.

\n

When players connect to the match's game session, they must include both player ID and\n player session ID in order to claim their assigned player slot.

" } }, "com.amazonaws.gamelift#MatchedPlayerSessionList": { @@ -8712,7 +11427,6 @@ "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 600 @@ -8725,7 +11439,7 @@ "Name": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.

" + "smithy.api#documentation": "

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking\n request or ticket.

" } }, "ConfigurationArn": { @@ -8743,7 +11457,7 @@ "GameSessionQueueArns": { "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. Queues can be located in any Region. Queues are used to start new\n GameLift-hosted game sessions for matches that are created with this matchmaking\n configuration. This property is not set when FlexMatchMode is set to\n STANDALONE.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. Queues can be located in any Region. Queues are used to start new\n GameLift-hosted game sessions for matches that are created with this matchmaking\n configuration. This property is not set when FlexMatchMode is set to\n STANDALONE.

" } }, "RequestTimeoutSeconds": { @@ -8767,13 +11481,13 @@ "RuleSetName": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use\n rule sets that are defined in the same Region.

" + "smithy.api#documentation": "

A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule\n sets that are defined in the same Region.

" } }, "RuleSetArn": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this\n configuration uses.

" } }, "NotificationTarget": { @@ -8785,7 +11499,7 @@ "AdditionalPlayerCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used when FlexMatchMode is set to\n STANDALONE.

" + "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used when FlexMatchMode is set to\n STANDALONE.

" } }, "CustomEventData": { @@ -8803,30 +11517,30 @@ "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match. This parameter is not used when\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is\n created for a successful match. This parameter is not used when\n FlexMatchMode is set to STANDALONE.

" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object\n that is created for a successful match. This parameter is not used when\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is\n created for a successful match. This parameter is not used when\n FlexMatchMode is set to STANDALONE.

" } }, "BackfillMode": { "target": "com.amazonaws.gamelift#BackfillMode", "traits": { - "smithy.api#documentation": "

The method used to backfill game sessions created with this matchmaking configuration.\n MANUAL indicates that the game makes backfill requests or does not use the match\n backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill existing games\n with FlexMatch. Automatic backfill is not available when\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

The method used to backfill game sessions created with this matchmaking configuration.\n MANUAL indicates that the game makes backfill requests or does not use the match\n backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a\n game session has one or more open slots. Learn more about manual and automatic backfill\n in Backfill existing games with FlexMatch. Automatic backfill is not available\n when FlexMatchMode is set to STANDALONE.

" } }, "FlexMatchMode": { "target": "com.amazonaws.gamelift#FlexMatchMode", "traits": { - "smithy.api#documentation": "

Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.

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

Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.

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

Guidelines for use with FlexMatch to match players into games. All matchmaking\n requests must specify a matchmaking configuration.

" + "smithy.api#documentation": "

Guidelines for use with FlexMatch to match players into games. All matchmaking requests\n must specify a matchmaking configuration.

" } }, "com.amazonaws.gamelift#MatchmakingConfigurationArn": { @@ -8859,42 +11573,56 @@ } }, "com.amazonaws.gamelift#MatchmakingConfigurationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CANCELLED", - "name": "CANCELLED" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "PLACING", - "name": "PLACING" - }, - { - "value": "QUEUED", - "name": "QUEUED" - }, - { - "value": "REQUIRES_ACCEPTANCE", - "name": "REQUIRES_ACCEPTANCE" - }, - { - "value": "SEARCHING", - "name": "SEARCHING" - }, - { - "value": "TIMED_OUT", - "name": "TIMED_OUT" + "type": "enum", + "members": { + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PLACING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLACING" + } + }, + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" } - ] + }, + "REQUIRES_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRES_ACCEPTANCE" + } + }, + "SEARCHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEARCHING" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + } } }, "com.amazonaws.gamelift#MatchmakingIdList": { @@ -8916,7 +11644,6 @@ "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 43200 @@ -8935,7 +11662,7 @@ "RuleSetArn": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::matchmakingruleset/. In a GameLift rule set ARN, the resource ID matches the\n RuleSetName value.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::matchmakingruleset/. In a GameLift rule set ARN, the resource ID matches the\n RuleSetName value.

" } }, "RuleSetBody": { @@ -8953,7 +11680,7 @@ } }, "traits": { - "smithy.api#documentation": "

Set of rule statements, used with FlexMatch, that determine how to build your player\n matches. Each rule set describes a type of group to be created and defines the\n parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.

\n

A rule set may define the following elements for a match. For detailed information\n and examples showing how to construct a rule set, see Build a FlexMatch rule\n set.

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

Set of rule statements, used with FlexMatch, that determine how to build your player\n matches. Each rule set describes a type of group to be created and defines the\n parameters for acceptable player matches.

\n

A rule set may define the following elements for a match. For detailed information and\n examples showing how to construct a rule set, see Build a FlexMatch rule\n set.

\n " } }, "com.amazonaws.gamelift#MatchmakingRuleSetArn": { @@ -9003,25 +11730,25 @@ "ConfigurationName": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

Name of the MatchmakingConfiguration that is used with this\n ticket. Matchmaking configurations determine how players are grouped into a match and\n how a new game session is created for the match.

" + "smithy.api#documentation": "

Name of the matchmaking configuration that is used with this ticket. Matchmaking\n configurations determine how players are grouped into a match and how a new game session\n is created for the match.

" } }, "ConfigurationArn": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used\n with this ticket.

" } }, "Status": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationStatus", "traits": { - "smithy.api#documentation": "

Current status of the matchmaking request.

\n \n \n

Matchmaking requests that fail to successfully complete (statuses FAILED,\n CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket\n IDs.

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

Current status of the matchmaking request.

\n \n \n

Matchmaking requests that fail to successfully complete (statuses FAILED,\n CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.

\n " } }, "StatusReason": { "target": "com.amazonaws.gamelift#StringModel", "traits": { - "smithy.api#documentation": "

Code to explain the current status. For example, a status reason may indicate when\n a ticket has returned to SEARCHING status after a proposed match fails to\n receive player acceptances.

" + "smithy.api#documentation": "

Code to explain the current status. For example, a status reason may indicate when a\n ticket has returned to SEARCHING status after a proposed match fails to\n receive player acceptances.

" } }, "StatusMessage": { @@ -9039,30 +11766,30 @@ "EndTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this matchmaking request stopped being processed due to\n success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Time stamp indicating when the matchmaking request stopped being processed due to\n successful completion, timeout, or cancellation. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, "Players": { "target": "com.amazonaws.gamelift#PlayerList", "traits": { - "smithy.api#documentation": "

A set of Player objects, each representing a player to find matches\n for. Players are identified by a unique player ID and may include latency data for use\n during matchmaking. If the ticket is in status COMPLETED, the\n Player objects include the team the players were assigned to in the\n resulting match.

" + "smithy.api#documentation": "

A set of Player objects, each representing a player to find matches for.\n Players are identified by a unique player ID and may include latency data for use during\n matchmaking. If the ticket is in status COMPLETED, the Player\n objects include the team the players were assigned to in the resulting match.

" } }, "GameSessionConnectionInfo": { "target": "com.amazonaws.gamelift#GameSessionConnectionInfo", "traits": { - "smithy.api#documentation": "

Identifier and connection information of the game session created for the match. This\n information is added to the ticket only after the matchmaking request has been\n successfully completed. This parameter is not set when FlexMatch is being used without\n GameLift hosting.

" + "smithy.api#documentation": "

Connection information for a new game session. Once a match is made, the FlexMatch\n engine creates a new game session for it. This information is added to the matchmaking\n ticket, which you can be retrieve by calling DescribeMatchmaking .

" } }, "EstimatedWaitTime": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

Average amount of time (in seconds) that players are currently waiting for a match.\n If there is not enough recent data, this property may be empty.

" + "smithy.api#documentation": "

Average amount of time (in seconds) that players are currently waiting for a match. If\n there is not enough recent data, this property may be empty.

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

Ticket generated to track the progress of a matchmaking request. Each ticket is\n uniquely identified by a ticket ID, supplied by the requester, when creating a\n matchmaking request with StartMatchmaking. Tickets can be retrieved by\n calling DescribeMatchmaking with the ticket ID.

" + "smithy.api#documentation": "

Ticket generated to track the progress of a matchmaking request. Each ticket is\n uniquely identified by a ticket ID, supplied by the requester, when creating a\n matchmaking request.

" } }, "com.amazonaws.gamelift#MatchmakingTicketList": { @@ -9074,7 +11801,6 @@ "com.amazonaws.gamelift#MaxConcurrentGameSessionActivations": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 2147483647 @@ -9103,54 +11829,80 @@ } }, "com.amazonaws.gamelift#MetricName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ActivatingGameSessions", - "name": "ActivatingGameSessions" - }, - { - "value": "ActiveGameSessions", - "name": "ActiveGameSessions" - }, - { - "value": "ActiveInstances", - "name": "ActiveInstances" - }, - { - "value": "AvailableGameSessions", - "name": "AvailableGameSessions" - }, - { - "value": "AvailablePlayerSessions", - "name": "AvailablePlayerSessions" - }, - { - "value": "CurrentPlayerSessions", - "name": "CurrentPlayerSessions" - }, - { - "value": "IdleInstances", - "name": "IdleInstances" - }, - { - "value": "PercentAvailableGameSessions", - "name": "PercentAvailableGameSessions" - }, - { - "value": "PercentIdleInstances", - "name": "PercentIdleInstances" - }, - { - "value": "QueueDepth", - "name": "QueueDepth" - }, - { - "value": "WaitTime", - "name": "WaitTime" + "type": "enum", + "members": { + "ActivatingGameSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActivatingGameSessions" + } + }, + "ActiveGameSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActiveGameSessions" + } + }, + "ActiveInstances": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActiveInstances" + } + }, + "AvailableGameSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AvailableGameSessions" + } + }, + "AvailablePlayerSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AvailablePlayerSessions" + } + }, + "CurrentPlayerSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentPlayerSessions" + } + }, + "IdleInstances": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IdleInstances" + } + }, + "PercentAvailableGameSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PercentAvailableGameSessions" + } + }, + "PercentIdleInstances": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PercentIdleInstances" } - ] + }, + "QueueDepth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QueueDepth" + } + }, + "WaitTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitTime" + } + }, + "ConcurrentActivatableGameSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConcurrentActivatableGameSessions" + } + } } }, "com.amazonaws.gamelift#NonBlankAndLengthConstraintString": { @@ -9180,12 +11932,21 @@ "com.amazonaws.gamelift#NonNegativeDouble": { "type": "double", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, + "com.amazonaws.gamelift#NonNegativeLimitedLengthDouble": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 11 + }, + "smithy.api#pattern": "^\\d{1,5}(?:\\.\\d{1,5})?$" + } + }, "com.amazonaws.gamelift#NonZeroAndMaxString": { "type": "string", "traits": { @@ -9203,27 +11964,31 @@ } }, "traits": { - "smithy.api#documentation": "

A service resource associated with the request could not be found. Clients should\n not retry such requests.

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

THe requested resources was not found. The resource was either not created yet or deleted.

", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#OperatingSystem": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WINDOWS_2012", - "name": "WINDOWS_2012" - }, - { - "value": "AMAZON_LINUX", - "name": "AMAZON_LINUX" - }, - { - "value": "AMAZON_LINUX_2", - "name": "AMAZON_LINUX_2" + "type": "enum", + "members": { + "WINDOWS_2012": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_2012" + } + }, + "AMAZON_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX" + } + }, + "AMAZON_LINUX_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX_2" } - ] + } } }, "com.amazonaws.gamelift#OutOfCapacityException": { @@ -9234,7 +11999,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified game server group has no available game servers to fulfill a\n ClaimGameServer request. Clients can retry such requests immediately\n or after a waiting period.\n \n

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

The specified game server group has no available game servers to fulfill a\n ClaimGameServer request. Clients can retry such requests immediately or\n after a waiting period.

", "smithy.api#error": "client" } }, @@ -9255,7 +12020,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player\n ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.

\n

\n Related actions\n

\n

\n CreatePlayerSession | \n CreatePlayerSessions | \n DescribePlayerSessions | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Information about a player session. This object contains only the player ID and player\n session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.

" } }, "com.amazonaws.gamelift#PlacedPlayerSessionList": { @@ -9276,24 +12041,24 @@ "PlayerAttributes": { "target": "com.amazonaws.gamelift#PlayerAttributeMap", "traits": { - "smithy.api#documentation": "

A collection of key:value pairs containing player information for use in matchmaking.\n Player attribute keys must match the playerAttributes used in a\n matchmaking rule set. Example: \"PlayerAttributes\": {\"skill\": {\"N\": \"23\"},\n \"gameMode\": {\"S\": \"deathmatch\"}}.

" + "smithy.api#documentation": "

A collection of key:value pairs containing player information for use in matchmaking.\n Player attribute keys must match the playerAttributes used in a\n matchmaking rule set. Example: \"PlayerAttributes\": {\"skill\": {\"N\": \"23\"},\n \"gameMode\": {\"S\": \"deathmatch\"}}.

\n

You can provide up to 10 PlayerAttributes.

" } }, "Team": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Name of the team that the player is assigned to in a match. Team names are defined\n in a matchmaking rule set.

" + "smithy.api#documentation": "

Name of the team that the player is assigned to in a match. Team names are defined in\n a matchmaking rule set.

" } }, "LatencyInMs": { "target": "com.amazonaws.gamelift#LatencyMap", "traits": { - "smithy.api#documentation": "

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. If this property is present, FlexMatch considers placing the match only\n in Regions for which latency is reported.

\n

If a matchmaker has a rule that evaluates player latency, players must report\n latency in order to be matched. If no latency is reported in this scenario, FlexMatch\n assumes that no Regions are available to the player and the ticket is not matchable.\n

" + "smithy.api#documentation": "

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. If this property is present, FlexMatch considers placing the match only in\n Regions for which latency is reported.

\n

If a matchmaker has a rule that evaluates player latency, players must report latency\n in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that\n no Regions are available to the player and the ticket is not matchable.

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

Represents a player in matchmaking. When starting a matchmaking request, a player\n has a player ID, attributes, and may have latency data. Team information is added after\n a match has been successfully completed.

" + "smithy.api#documentation": "

Represents a player in matchmaking. When starting a matchmaking request, a player has\n a player ID, attributes, and may have latency data. Team information is added after a\n match has been successfully completed.

" } }, "com.amazonaws.gamelift#PlayerAttributeMap": { @@ -9305,6 +12070,30 @@ "target": "com.amazonaws.gamelift#AttributeValue" } }, + "com.amazonaws.gamelift#PlayerAttributeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.gamelift#PlayerAttributeStringDoubleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.gamelift#PlayerAttributeString" + }, + "value": { + "target": "com.amazonaws.gamelift#DoubleObject" + } + }, + "com.amazonaws.gamelift#PlayerAttributeStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#PlayerAttributeString" + } + }, "com.amazonaws.gamelift#PlayerData": { "type": "string", "traits": { @@ -9353,12 +12142,13 @@ "LatencyInMilliseconds": { "target": "com.amazonaws.gamelift#Float", "traits": { - "smithy.api#documentation": "

Amount of time that represents the time lag experienced by the player when\n connected to the specified Region.

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

Amount of time that represents the time lag experienced by the player when connected\n to the specified Region.

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

Regional latency information for a player, used when requesting a new game session\n with StartGameSessionPlacement. This value indicates the amount of\n time lag that exists when the player is connected to a fleet in the specified Region.\n The relative difference between a player's latency values for multiple Regions are used\n to determine which fleets are best suited to place a new game session for the player.\n

" + "smithy.api#documentation": "

Regional latency information for a player, used when requesting a new game session.\n This value indicates the amount of time lag that exists when the player is connected to\n a fleet in the specified Region. The relative difference between a player's latency\n values for multiple Regions are used to determine which fleets are best suited to place\n a new game session for the player.

" } }, "com.amazonaws.gamelift#PlayerLatencyList": { @@ -9379,12 +12169,12 @@ "PolicyDurationSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The length of time, in seconds, that the policy is enforced while placing a new\n game session. A null value for this property means that the policy is enforced until the\n queue times out.

" + "smithy.api#documentation": "

The length of time, in seconds, that the policy is enforced while placing a new game\n session. A null value for this property means that the policy is enforced until the\n queue times out.

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

Sets a latency cap for individual players when placing a game session. With a latency\n policy in force, a game session cannot be placed in a fleet location where a player\n reports latency higher than the cap. Latency policies are used only with placement\n request that provide player latency information. Player latency policies can be stacked\n to gradually relax latency requirements over time.

\n

Latency policies are part of a GameSessionQueue.

" + "smithy.api#documentation": "

Sets a latency cap for individual players when placing a game session. With a latency\n policy in force, a game session cannot be placed in a fleet location where a player\n reports latency higher than the cap. Latency policies are used only with placement\n request that provide player latency information. Player latency policies can be stacked\n to gradually relax latency requirements over time.

" } }, "com.amazonaws.gamelift#PlayerLatencyPolicyList": { @@ -9429,7 +12219,7 @@ "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on. \n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is\n running on.

" } }, "CreationTime": { @@ -9447,7 +12237,7 @@ "Status": { "target": "com.amazonaws.gamelift#PlayerSessionStatus", "traits": { - "smithy.api#documentation": "

Current status of the player session.

\n

Possible player session statuses include the following:

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

Current status of the player session.

\n

Possible player session statuses include the following:

\n " } }, "IpAddress": { @@ -9465,7 +12255,7 @@ "Port": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift server process, an app\n needs both the IP address and port number.

" + "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift server process, an app needs\n both the IP address and port number.

" } }, "PlayerData": { @@ -9476,22 +12266,24 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a player session. Player sessions are created either for a specific game\n session, or as part of a game session placement or matchmaking request. A player session\n can represents a reserved player slot in a game session (when status is\n RESERVED) or actual player activity in a game session (when status is\n ACTIVE). A player session object, including player data, is\n automatically passed to a game session when the player connects to the game session and\n is validated. After the game session ends, player sessions information is retained for\n 30 days and then removed.

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

" + "smithy.api#documentation": "

Represents a player session. Player sessions are created either for a specific game\n session, or as part of a game session placement or matchmaking request. A player session\n can represents a reserved player slot in a game session (when status is\n RESERVED) or actual player activity in a game session (when status is\n ACTIVE). A player session object, including player data, is\n automatically passed to a game session when the player connects to the game session and\n is validated. After the game session ends, player sessions information is retained for\n 30 days and then removed.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#PlayerSessionCreationPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACCEPT_ALL", - "name": "ACCEPT_ALL" - }, - { - "value": "DENY_ALL", - "name": "DENY_ALL" + "type": "enum", + "members": { + "ACCEPT_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT_ALL" + } + }, + "DENY_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_ALL" } - ] + } } }, "com.amazonaws.gamelift#PlayerSessionId": { @@ -9507,47 +12299,54 @@ } }, "com.amazonaws.gamelift#PlayerSessionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RESERVED", - "name": "RESERVED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "TIMEDOUT", - "name": "TIMEDOUT" + "type": "enum", + "members": { + "RESERVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" } - ] + }, + "TIMEDOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEDOUT" + } + } } }, "com.amazonaws.gamelift#PolicyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RuleBased", - "name": "RuleBased" - }, - { - "value": "TargetBased", - "name": "TargetBased" + "type": "enum", + "members": { + "RuleBased": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RuleBased" + } + }, + "TargetBased": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TargetBased" } - ] + } } }, "com.amazonaws.gamelift#PortNumber": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 60000 @@ -9557,7 +12356,6 @@ "com.amazonaws.gamelift#PositiveInteger": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -9566,7 +12364,6 @@ "com.amazonaws.gamelift#PositiveLong": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -9584,35 +12381,41 @@ "LocationOrder": { "target": "com.amazonaws.gamelift#LocationList", "traits": { - "smithy.api#documentation": "

The prioritization order to use for fleet locations, when the\n PriorityOrder property includes LOCATION. Locations are\n identified by Amazon Web Services Region codes such as us-west-2. Each location can only be\n listed once.

" + "smithy.api#documentation": "

The prioritization order to use for fleet locations, when the\n PriorityOrder property includes LOCATION. Locations are\n identified by Amazon Web Services Region codes such as us-west-2. Each location can only\n be listed once.

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

Custom prioritization settings for use by a game session queue when placing new game\n sessions with available game servers. When defined, this configuration replaces the\n default FleetIQ prioritization process, which is as follows:

\n \n

Changing the priority order will affect how game sessions are placed.

\n

Priority configurations are part of a GameSessionQueue.

" + "smithy.api#documentation": "

Custom prioritization settings for use by a game session queue when placing new game\n sessions with available game servers. When defined, this configuration replaces the\n default FleetIQ prioritization process, which is as follows:

\n \n

Changing the priority order will affect how game sessions are placed.

" } }, "com.amazonaws.gamelift#PriorityType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LATENCY", - "name": "LATENCY" - }, - { - "value": "COST", - "name": "COST" - }, - { - "value": "DESTINATION", - "name": "DESTINATION" - }, - { - "value": "LOCATION", - "name": "LOCATION" + "type": "enum", + "members": { + "LATENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATENCY" + } + }, + "COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST" + } + }, + "DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESTINATION" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" } - ] + } } }, "com.amazonaws.gamelift#PriorityTypeList": { @@ -9628,18 +12431,20 @@ } }, "com.amazonaws.gamelift#ProtectionPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NoProtection", - "name": "NoProtection" - }, - { - "value": "FullProtection", - "name": "FullProtection" + "type": "enum", + "members": { + "NoProtection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoProtection" + } + }, + "FullProtection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullProtection" } - ] + } } }, "com.amazonaws.gamelift#PutScalingPolicy": { @@ -9665,7 +12470,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a scaling policy for a fleet. Scaling policies are used to\n automatically scale a fleet's hosting capacity to meet player demand. An active scaling\n policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's\n capacity when a certain threshold is reached. There are two types of scaling policies:\n target-based and rule-based. Use a target-based policy to quickly and efficiently manage\n fleet scaling; this option is the most commonly used. Use rule-based policies when you\n need to exert fine-grained control over auto-scaling.

\n

Fleets can have multiple scaling policies of each type in force at the same time;\n you can have one target-based policy, one or multiple rule-based scaling policies, or\n both. We recommend caution, however, because multiple auto-scaling policies can have\n unintended consequences.

\n

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling\n policies, call StartFleetActions with the same fleet action. To stop\n just one scaling policy--or to permanently remove it, you must delete the policy with\n DeleteScalingPolicy.

\n

Learn more about how to work with auto-scaling in Set Up Fleet Automatic\n Scaling.

\n

\n Target-based policy\n

\n

A target-based policy tracks a single metric: PercentAvailableGameSessions. This\n metric tells us how much of a fleet's hosting capacity is ready to host game sessions\n but is not currently in use. This is the fleet's buffer; it measures the additional\n player demand that the fleet could handle at current capacity. With a target-based\n policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action\n is needed to maintain that target.

\n

For example, you might choose to maintain a 10% buffer for a fleet that has the\n capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take\n action whenever the fleet's available capacity falls below or rises above 10 game\n sessions. Amazon GameLift will start new instances or stop unused instances in order to return\n to the 10% buffer.

\n

To create or update a target-based policy, specify a fleet ID and name, and set the\n policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions)\n and reference a TargetConfiguration object with your desired buffer\n value. Exclude all other parameters. On a successful request, the policy name is\n returned. The scaling policy is automatically in force as soon as it's successfully\n created. If the fleet's auto-scaling actions are temporarily suspended, the new policy\n will be in force once the fleet actions are restarted.

\n

\n Rule-based policy\n

\n

A rule-based policy tracks specified fleet metric, sets a threshold value, and\n specifies the type of action to initiate when triggered. With a rule-based policy, you\n can select from several available fleet metrics. Each policy specifies whether to scale\n up or scale down (and by how much), so you need one policy for each type of action.

\n

For example, a policy may make the following statement: \"If the percentage of idle\n instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity\n by 10%.\"

\n

A policy's rule statement has the following structure:

\n

If [MetricName] is [ComparisonOperator]\n [Threshold] for [EvaluationPeriods] minutes, then\n [ScalingAdjustmentType] to/by\n [ScalingAdjustment].

\n

To implement the example, the rule statement would look like this:

\n

If [PercentIdleInstances] is [GreaterThanThreshold]\n [20] for [15] minutes, then\n [PercentChangeInCapacity] to/by [10].

\n

To create or update a scaling policy, specify a unique combination of name and\n fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a\n policy rule statement. On a successful request, the policy name is returned. Scaling\n policies are automatically in force as soon as they're successfully created. If the\n fleet's auto-scaling actions are temporarily suspended, the new policy will be in force\n once the fleet actions are restarted.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates or updates a scaling policy for a fleet. Scaling policies are used to\n automatically scale a fleet's hosting capacity to meet player demand. An active scaling\n policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's\n capacity when a certain threshold is reached. There are two types of scaling policies:\n target-based and rule-based. Use a target-based policy to quickly and efficiently manage\n fleet scaling; this option is the most commonly used. Use rule-based policies when you\n need to exert fine-grained control over auto-scaling.

\n

Fleets can have multiple scaling policies of each type in force at the same time; you\n can have one target-based policy, one or multiple rule-based scaling policies, or both.\n We recommend caution, however, because multiple auto-scaling policies can have\n unintended consequences.

\n

Learn more about how to work with auto-scaling in Set Up Fleet Automatic\n Scaling.

\n

\n Target-based policy\n

\n

A target-based policy tracks a single metric: PercentAvailableGameSessions. This\n metric tells us how much of a fleet's hosting capacity is ready to host game sessions\n but is not currently in use. This is the fleet's buffer; it measures the additional\n player demand that the fleet could handle at current capacity. With a target-based\n policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is\n needed to maintain that target.

\n

For example, you might choose to maintain a 10% buffer for a fleet that has the\n capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action\n whenever the fleet's available capacity falls below or rises above 10 game sessions.\n Amazon GameLift will start new instances or stop unused instances in order to return to the 10%\n buffer.

\n

To create or update a target-based policy, specify a fleet ID and name, and set the\n policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions)\n and reference a TargetConfiguration object with your desired buffer value.\n Exclude all other parameters. On a successful request, the policy name is returned. The\n scaling policy is automatically in force as soon as it's successfully created. If the\n fleet's auto-scaling actions are temporarily suspended, the new policy will be in force\n once the fleet actions are restarted.

\n

\n Rule-based policy\n

\n

A rule-based policy tracks specified fleet metric, sets a threshold value, and\n specifies the type of action to initiate when triggered. With a rule-based policy, you\n can select from several available fleet metrics. Each policy specifies whether to scale\n up or scale down (and by how much), so you need one policy for each type of action.

\n

For example, a policy may make the following statement: \"If the percentage of idle\n instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity\n by 10%.\"

\n

A policy's rule statement has the following structure:

\n

If [MetricName] is [ComparisonOperator]\n [Threshold] for [EvaluationPeriods] minutes, then\n [ScalingAdjustmentType] to/by [ScalingAdjustment].

\n

To implement the example, the rule statement would look like this:

\n

If [PercentIdleInstances] is [GreaterThanThreshold]\n [20] for [15] minutes, then\n [PercentChangeInCapacity] to/by [10].

\n

To create or update a scaling policy, specify a unique combination of name and fleet\n ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy\n rule statement. On a successful request, the policy name is returned. Scaling policies\n are automatically in force as soon as they're successfully created. If the fleet's\n auto-scaling actions are temporarily suspended, the new policy will be in force once the\n fleet actions are restarted.

" } }, "com.amazonaws.gamelift#PutScalingPolicyInput": { @@ -9688,18 +12493,20 @@ "ScalingAdjustment": { "target": "com.amazonaws.gamelift#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

Amount of adjustment to make, based on the scaling adjustment type.

" } }, "ScalingAdjustmentType": { "target": "com.amazonaws.gamelift#ScalingAdjustmentType", "traits": { - "smithy.api#documentation": "

The type of adjustment to make to a fleet's instance count (see FleetCapacity):

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

The type of adjustment to make to a fleet's instance count:

\n " } }, "Threshold": { "target": "com.amazonaws.gamelift#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

Metric value used to trigger a scaling event.

" } }, @@ -9734,9 +12541,6 @@ "smithy.api#documentation": "

An object that contains settings for a target-based scaling policy.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#PutScalingPolicyOutput": { @@ -9748,9 +12552,6 @@ "smithy.api#documentation": "

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#QueueArnsList": { @@ -9779,6 +12580,86 @@ "smithy.api#pattern": "^[a-zA-Z0-9:_-]*(\\.fifo)?$" } }, + "com.amazonaws.gamelift#RegisterCompute": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#RegisterComputeInput" + }, + "output": { + "target": "com.amazonaws.gamelift#RegisterComputeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#ConflictException" + }, + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers your compute resources in a fleet you previously created. After you register\n a compute to your fleet, you can monitor and manage your compute using GameLift. The\n operation returns the compute resource containing SDK endpoint you can use to connect\n your game server to GameLift.

\n

\n Learn more\n

\n " + } + }, + "com.amazonaws.gamelift#RegisterComputeInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.

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

A descriptive label that is associated with the compute resource registered to your fleet.

", + "smithy.api#required": {} + } + }, + "CertificatePath": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

The path to the TLS certificate on your compute resource. The path and certificate are\n not validated by GameLift.

" + } + }, + "DnsName": { + "target": "com.amazonaws.gamelift#DnsNameInput", + "traits": { + "smithy.api#documentation": "

The DNS name of the compute resource. GameLift requires the DNS name or IP address to\n manage your compute resource.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.gamelift#IpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the compute resource. GameLift requires the DNS name or IP address to\n manage your compute resource.

" + } + }, + "Location": { + "target": "com.amazonaws.gamelift#LocationStringModel", + "traits": { + "smithy.api#documentation": "

The name of the custom location you added to the fleet you are registering this\n compute resource to.

" + } + } + } + }, + "com.amazonaws.gamelift#RegisterComputeOutput": { + "type": "structure", + "members": { + "Compute": { + "target": "com.amazonaws.gamelift#Compute", + "traits": { + "smithy.api#documentation": "

The details of the compute resource you registered to the specified fleet.

" + } + } + } + }, "com.amazonaws.gamelift#RegisterGameServer": { "type": "operation", "input": { @@ -9805,7 +12686,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to\n host gameplay and players. This operation is called by a game server process that is\n running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to\n track available game servers and enables game clients and services to claim a game\n server for a new game session.

\n

To register a game server, identify the game server group and instance where the game\n server is running, and provide a unique identifier for the game server. You can also\n include connection and game server data. When a game client or service requests a game\n server by calling ClaimGameServer, this information is returned in the\n response.

\n

Once a game server is successfully registered, it is put in status\n AVAILABLE. A request to register a game server may fail if the instance\n it is running on is in the process of shutting down as part of instance balancing or\n scale-down activity.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Creates a new game server\n resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players.\n This operation is called by a game server process that is running on an instance in a\n game server group. Registering game servers enables GameLift FleetIQ to track available game\n servers and enables game clients and services to claim a game server for a new game\n session.

\n

To register a game server, identify the game server group and instance where the game\n server is running, and provide a unique identifier for the game server. You can also\n include connection and game server data.

\n

Once a game server is successfully registered, it is put in status\n AVAILABLE. A request to register a game server may fail if the instance\n it is running on is in the process of shutting down as part of instance balancing or\n scale-down activity.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#RegisterGameServerInput": { @@ -9814,14 +12695,14 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group where the game server is running.

", "smithy.api#required": {} } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { - "smithy.api#documentation": "

A custom string that uniquely identifies the game server to register. \n Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

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

A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique\n across all game server groups in your Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -9841,7 +12722,7 @@ "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers.

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

Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n CreateBuild.

\n

To request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.

\n

\n Learn more\n

\n

\n \n Create a Build with Files in S3\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n GameSession.

\n

To request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.

\n

\n Learn more\n

\n

\n Create a Build with Files in S3\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#RequestUploadCredentialsInput": { @@ -9893,9 +12774,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#RequestUploadCredentialsOutput": { @@ -9904,7 +12782,7 @@ "UploadCredentials": { "target": "com.amazonaws.gamelift#AwsCredentials", "traits": { - "smithy.api#documentation": "

Amazon Web Services credentials required when uploading a game build to the storage location.\n These credentials have a limited lifespan and are valid only for the build they were\n issued for.

" + "smithy.api#documentation": "

Amazon Web Services credentials required when uploading a game build to the storage location. These\n credentials have a limited lifespan and are valid only for the build they were issued\n for.

" } }, "StorageLocation": { @@ -9913,9 +12791,6 @@ "smithy.api#documentation": "

Amazon S3 path and key, identifying where the game build files are\n stored.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ResolveAlias": { @@ -9944,7 +12819,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the fleet ID that an alias is currently pointing to.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves the fleet ID that an alias is currently pointing to.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#ResolveAliasInput": { @@ -9957,9 +12832,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ResolveAliasOutput": { @@ -9974,12 +12846,9 @@ "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to. \n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to.\n

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ResourceCreationLimitPolicy": { @@ -9988,7 +12857,7 @@ "NewGameSessionsPerCreator": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The maximum number of game sessions that an individual can create during the policy\n period.

" + "smithy.api#documentation": "

A policy that puts limits on the number of game sessions that a player can create\n within a specified span of time. With this policy, you can control players' ability to\n consume available resources.

\n

The policy is evaluated when a player tries to create a new game session. On receiving\n a CreateGameSession request, GameLift checks that the player (identified by\n CreatorId) has created fewer than game session limit in the specified\n time period.

" } }, "PolicyPeriodInMinutes": { @@ -9999,7 +12868,7 @@ } }, "traits": { - "smithy.api#documentation": "

A policy that puts limits on the number of game sessions that a player can create\n within a specified span of time. With this policy, you can control players' ability to\n consume available resources.

\n

The policy is evaluated when a player tries to create a new game session. On receiving\n a CreateGameSession request, GameLift checks that the player (identified by\n CreatorId) has created fewer than game session limit in the specified\n time period.

\n

The resource creation limit policy is included in FleetAttributes.

" + "smithy.api#documentation": "

A policy that puts limits on the number of game sessions that a player can create\n within a specified span of time. With this policy, you can control players' ability to\n consume available resources.

\n

The policy is evaluated when a player tries to create a new game session. On receiving\n a CreateGameSession request, GameLift checks that the player (identified by\n CreatorId) has created fewer than game session limit in the specified\n time period.

" } }, "com.amazonaws.gamelift#ResumeGameServerGroup": { @@ -10025,7 +12894,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Reinstates activity on a game server group after it has been suspended. A game server\n group might be suspended by theSuspendGameServerGroup operation, or it\n might be suspended involuntarily due to a configuration problem. In the second case, you\n can manually resume activity on the group once the configuration problem has been\n resolved. Refer to the game server group status and status reason for more information\n on why group activity is suspended.

\n

To resume activity, specify a game server group ARN and the type of activity to be\n resumed. If successful, a GameServerGroup object is returned showing\n that the resumed activity is no longer listed in SuspendedActions.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Reinstates activity on a game\n server group after it has been suspended. A game server group might be suspended by the\n SuspendGameServerGroup operation, or it might be suspended involuntarily\n due to a configuration problem. In the second case, you can manually resume activity on\n the group once the configuration problem has been resolved. Refer to the game server\n group status and status reason for more information on why group activity is\n suspended.

\n

To resume activity, specify a game server group ARN and the type of activity to be\n resumed. If successful, a GameServerGroup object is returned showing that\n the resumed activity is no longer listed in SuspendedActions.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#ResumeGameServerGroupInput": { @@ -10034,7 +12903,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group. Use either the name or ARN value.

", "smithy.api#required": {} } }, @@ -10064,7 +12933,7 @@ "Type": { "target": "com.amazonaws.gamelift#RoutingStrategyType", "traits": { - "smithy.api#documentation": "

The type of routing strategy for the alias.

\n

Possible routing types include the following:

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

The type of routing strategy for the alias.

\n

Possible routing types include the following:

\n " } }, "FleetId": { @@ -10081,22 +12950,24 @@ } }, "traits": { - "smithy.api#documentation": "

The routing configuration for a fleet alias.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

The routing configuration for a fleet alias.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#RoutingStrategyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SIMPLE", - "name": "SIMPLE" - }, - { - "value": "TERMINAL", - "name": "TERMINAL" + "type": "enum", + "members": { + "SIMPLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIMPLE" + } + }, + "TERMINAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINAL" } - ] + } } }, "com.amazonaws.gamelift#RuleSetBody": { @@ -10111,7 +12982,6 @@ "com.amazonaws.gamelift#RuleSetLimit": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 @@ -10141,7 +13011,7 @@ } }, "traits": { - "smithy.api#documentation": "

A collection of server process configurations that describe the set of processes to\n run on each instance in a fleet. Server processes run either an executable in a custom\n game build or a Realtime Servers script. GameLift launches the configured processes, manages their\n life cycle, and replaces them as needed. Each instance checks regularly for an updated\n runtime configuration.

\n

A GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes in a runtime configuration, add the values of the\n ConcurrentExecutions parameter for each ServerProcess. Learn more about Running Multiple\n Processes on a Fleet.

\n

\n Related actions\n

\n

\n DescribeRuntimeConfiguration | UpdateRuntimeConfiguration\n

" + "smithy.api#documentation": "

A collection of server process configurations that describe the set of processes to\n run on each instance in a fleet. Server processes run either an executable in a custom\n game build or a Realtime Servers script. GameLift launches the configured processes, manages their\n life cycle, and replaces them as needed. Each instance checks regularly for an updated\n runtime configuration.

\n

A GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes in a runtime configuration, add the values of the\n ConcurrentExecutions parameter for each server process. Learn more\n about Running Multiple\n Processes on a Fleet.

" } }, "com.amazonaws.gamelift#S3Location": { @@ -10150,7 +13020,7 @@ "Bucket": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

An Amazon S3 bucket identifier. This is the name of the S3 bucket.

\n \n

GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).

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

An Amazon S3 bucket identifier. Thename of the S3 bucket.

\n \n

GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot\n (.).

\n " } }, "Key": { @@ -10173,26 +13043,30 @@ } }, "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This\n location is specified in CreateBuild, CreateScript,\n and UpdateScript requests.

" + "smithy.api#documentation": "

The location in Amazon S3 where build or script files are stored for access by\n Amazon GameLift.

" } }, "com.amazonaws.gamelift#ScalingAdjustmentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ChangeInCapacity", - "name": "ChangeInCapacity" - }, - { - "value": "ExactCapacity", - "name": "ExactCapacity" - }, - { - "value": "PercentChangeInCapacity", - "name": "PercentChangeInCapacity" + "type": "enum", + "members": { + "ChangeInCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeInCapacity" + } + }, + "ExactCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExactCapacity" + } + }, + "PercentChangeInCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PercentChangeInCapacity" } - ] + } } }, "com.amazonaws.gamelift#ScalingPolicy": { @@ -10219,37 +13093,39 @@ "Status": { "target": "com.amazonaws.gamelift#ScalingStatusType", "traits": { - "smithy.api#documentation": "

Current status of the scaling policy. The scaling policy can be in force only when\n in an ACTIVE status. Scaling policies can be suspended for individual\n fleets (see StopFleetActions; if suspended for a fleet, the policy\n status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.

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

Current status of the scaling policy. The scaling policy can be in force only when in\n an ACTIVE status. Scaling policies can be suspended for individual fleets.\n If the policy is suspended for a fleet, the policy status does not change.

\n " } }, "ScalingAdjustment": { "target": "com.amazonaws.gamelift#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

Amount of adjustment to make, based on the scaling adjustment type.

" } }, "ScalingAdjustmentType": { "target": "com.amazonaws.gamelift#ScalingAdjustmentType", "traits": { - "smithy.api#documentation": "

The type of adjustment to make to a fleet's instance count (see FleetCapacity):

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

The type of adjustment to make to a fleet's instance count.

\n " } }, "ComparisonOperator": { "target": "com.amazonaws.gamelift#ComparisonOperatorType", "traits": { - "smithy.api#documentation": "

Comparison operator to use when measuring a metric against the threshold\n value.

" + "smithy.api#documentation": "

Comparison operator to use when measuring a metric against the threshold value.

" } }, "Threshold": { "target": "com.amazonaws.gamelift#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

Metric value used to trigger a scaling event.

" } }, "EvaluationPeriods": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.

" + "smithy.api#documentation": "

Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.

" } }, "MetricName": { @@ -10273,18 +13149,18 @@ "UpdateStatus": { "target": "com.amazonaws.gamelift#LocationUpdateStatus", "traits": { - "smithy.api#documentation": "

The current status of the fleet's scaling policies in a requested fleet location. The\n status PENDING_UPDATE indicates that an update was requested for the fleet \n but has not yet been completed for the location.

" + "smithy.api#documentation": "

The current status of the fleet's scaling policies in a requested fleet location. The\n status PENDING_UPDATE indicates that an update was requested for the fleet\n but has not yet been completed for the location.

" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

\n The fleet location.\n

" + "smithy.api#documentation": "

The fleet location.

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

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified\n by the combination of name and fleet ID.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" + "smithy.api#documentation": "

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by\n the combination of name and fleet ID.

" } }, "com.amazonaws.gamelift#ScalingPolicyList": { @@ -10294,38 +13170,50 @@ } }, "com.amazonaws.gamelift#ScalingStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "UPDATE_REQUESTED", - "name": "UPDATE_REQUESTED" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "DELETE_REQUESTED", - "name": "DELETE_REQUESTED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "ERROR", - "name": "ERROR" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATE_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_REQUESTED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" } - ] + }, + "DELETE_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_REQUESTED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } } }, "com.amazonaws.gamelift#Script": { @@ -10340,7 +13228,7 @@ "ScriptArn": { "target": "com.amazonaws.gamelift#ScriptArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the\n ScriptId value.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the\n ScriptId value.

" } }, "Name": { @@ -10352,7 +13240,7 @@ "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique.

" + "smithy.api#documentation": "

Version information associated with a build or script. Version strings do not need to be unique.

" } }, "SizeOnDisk": { @@ -10368,11 +13256,14 @@ } }, "StorageLocation": { - "target": "com.amazonaws.gamelift#S3Location" + "target": "com.amazonaws.gamelift#S3Location", + "traits": { + "smithy.api#documentation": "

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.

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

Properties describing a Realtime script.

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Properties describing a Realtime script.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#ScriptArn": { @@ -10428,7 +13319,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all active game sessions that match a set of search criteria and sorts them\n into a specified order.

\n

This operation is not designed to be continually called to track game session status. \n This practice can cause you to exceed your API limit, which results in errors. Instead, \n you must configure configure an \n Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling game session status \n with DescribeGameSessions should only be used for games in development with \n low game session usage.\n

\n

When searching for game sessions, you specify exactly where you want to search and\n provide a search filter expression, a sort expression, or both. A search request can\n search only one fleet, but it can search all of a fleet's locations.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSession object is returned for each game session\n that matches the request. Search finds game sessions that are in ACTIVE\n status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions.

\n

You can search or sort by the following game session attributes:

\n \n \n

Returned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.

\n \n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

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

Retrieves all active game sessions that match a set of search criteria and sorts them\n into a specified order.

\n

This operation is not designed to be continually called to track game session status.\n This practice can cause you to exceed your API limit, which results in errors. Instead,\n you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from\n FlexMatch or queues. Continuously polling game session status with\n DescribeGameSessions should only be used for games in development with\n low game session usage.

\n

When searching for game sessions, you specify exactly where you want to search and\n provide a search filter expression, a sort expression, or both. A search request can\n search only one fleet, but it can search all of a fleet's locations.

\n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSession object is returned for each game session\n that matches the request. Search finds game sessions that are in ACTIVE\n status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .

\n

You can search or sort by the following game session attributes:

\n \n \n

Returned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.

\n \n

\n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -10455,25 +13346,25 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

A fleet location to search for game sessions. You can specify a fleet's home Region or\n a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

\n

" + "smithy.api#documentation": "

A fleet location to search for game sessions. You can specify a fleet's home Region or\n a remote location. Use the Amazon Web Services Region code format, such as us-west-2.\n

" } }, "FilterExpression": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

String containing the search criteria for the session search. If no filter\n expression is included, the request returns results for all game sessions in the fleet\n that are in ACTIVE status.

\n

A filter expression can contain one or multiple conditions. Each condition consists\n of the following:

\n \n

To chain multiple conditions in a single expression, use the logical keywords\n AND, OR, and NOT and parentheses as needed.\n For example: x AND y AND NOT z, NOT (x OR y).

\n

Session search evaluates conditions from left to right using the following\n precedence rules:

\n
    \n
  1. \n

    \n =, <>, <, >,\n <=, >=\n

    \n
    2. \n
  2. \n

    Parentheses

    \n
    3. \n
  3. \n

    NOT

    \n
    4. \n
  4. \n

    AND

    \n
    5. \n
  5. \n

    OR

    \n
    6. \n
\n

For example, this filter expression retrieves game sessions hosting at least ten\n players that have an open player slot: \"maximumSessions>=10 AND\n hasAvailablePlayerSessions=true\".

" + "smithy.api#documentation": "

String containing the search criteria for the session search. If no filter expression\n is included, the request returns results for all game sessions in the fleet that are in\n ACTIVE status.

\n

A filter expression can contain one or multiple conditions. Each condition consists of\n the following:

\n \n

To chain multiple conditions in a single expression, use the logical keywords\n AND, OR, and NOT and parentheses as needed.\n For example: x AND y AND NOT z, NOT (x OR y).

\n

Session search evaluates conditions from left to right using the following precedence\n rules:

\n
    \n
  1. \n

    \n =, <>, <, >,\n <=, >=\n

    \n
    2. \n
  2. \n

    Parentheses

    \n
    3. \n
  3. \n

    NOT

    \n
    4. \n
  4. \n

    AND

    \n
    5. \n
  5. \n

    OR

    \n
    6. \n
\n

For example, this filter expression retrieves game sessions hosting at least ten\n players that have an open player slot: \"maximumSessions>=10 AND\n hasAvailablePlayerSessions=true\".

" } }, "SortExpression": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Instructions on how to sort the search results. If no sort expression is included,\n the request returns results in random order. A sort expression consists of the following\n elements:

\n \n

For example, this sort expression returns the oldest active sessions first:\n \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value\n for the sort operand are returned at the end of the list.

" + "smithy.api#documentation": "

Instructions on how to sort the search results. If no sort expression is included, the\n request returns results in random order. A sort expression consists of the following\n elements:

\n \n

For example, this sort expression returns the oldest active sessions first:\n \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value\n for the sort operand are returned at the end of the list.

" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set\n or is set higher than 20.

" + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or\n is set higher than 20.

" } }, "NextToken": { @@ -10482,9 +13373,6 @@ "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#SearchGameSessionsOutput": { @@ -10502,9 +13390,6 @@ "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ServerProcess": { @@ -10513,7 +13398,7 @@ "LaunchPath": { "target": "com.amazonaws.gamelift#LaunchPathStringModel", "traits": { - "smithy.api#documentation": "

The location of a game build executable or the Realtime script file that contains the\n Init() function. Game builds and Realtime scripts are installed on\n instances at the root:

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

The location of a game build executable or the Realtime script file that contains the\n Init() function. Game builds and Realtime scripts are installed on\n instances at the root:

\n ", "smithy.api#required": {} } }, @@ -10532,7 +13417,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of instructions for launching server processes on each instance in a fleet.\n Server processes run either an executable in a custom game build or a Realtime Servers script.\n Server process configurations are part of a fleet's RuntimeConfiguration.

" + "smithy.api#documentation": "

A set of instructions for launching server processes on each instance in a fleet.\n Server processes run either an executable in a custom game build or a Realtime Servers script.\n Server process configurations are part of a fleet's runtime configuration.

" } }, "com.amazonaws.gamelift#ServerProcessList": { @@ -10547,6 +13432,17 @@ } } }, + "com.amazonaws.gamelift#ServerSdkVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Data type used for server SDK version.", + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, "com.amazonaws.gamelift#SnsArnStringModel": { "type": "string", "traits": { @@ -10558,18 +13454,20 @@ } }, "com.amazonaws.gamelift#SortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASCENDING", - "name": "ASCENDING" - }, - { - "value": "DESCENDING", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" } - ] + } } }, "com.amazonaws.gamelift#StartFleetActions": { @@ -10598,7 +13496,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed\n separately for each location. Currently, this operation is used to restart a fleet's\n auto-scaling activity.

\n

This operation can be used in the following ways:

\n \n

If successful, GameLift once again initiates scaling events as triggered by the fleet's\n scaling policies. If actions on the fleet location were never stopped, this operation\n will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n

" + "smithy.api#documentation": "

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed\n separately for each location. Currently, this operation is used to restart a fleet's\n auto-scaling activity.

\n

This operation can be used in the following ways:

\n \n

If successful, GameLift once again initiates scaling events as triggered by the fleet's\n scaling policies. If actions on the fleet location were never stopped, this operation\n will have no effect.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#StartFleetActionsInput": { @@ -10607,7 +13505,7 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.

", "smithy.api#required": {} } }, @@ -10621,12 +13519,9 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The fleet location to restart fleet actions for. Specify a location in the form of\n an Amazon Web Services Region code, such as us-west-2.

" + "smithy.api#documentation": "

The fleet location to restart fleet actions for. Specify a location in the form of an\n Amazon Web Services Region code, such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StartFleetActionsOutput": { @@ -10644,9 +13539,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StartGameSessionPlacement": { @@ -10672,7 +13564,7 @@ } ], "traits": { - "smithy.api#documentation": "

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift\n searches for available resources on the queue's destinations, scanning each until it\n finds resources or the placement request times out.

\n

A game session placement request can also request player sessions. When a new game\n session is successfully created, Amazon GameLift creates a player session for each player\n included in the request.

\n

When placing a game session, by default Amazon GameLift tries each fleet in the order they\n are listed in the queue configuration. Ideally, a queue's destinations are listed in\n preference order.

\n

Alternatively, when requesting a game session with players, you can also provide\n latency data for each player in relevant Regions. Latency data indicates the performance\n lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency\n data to reorder the list of destinations to place the game session in a Region with\n minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each\n Region's average lag for all players and reorders to get the best game play across all\n players.

\n

To place a new game session request, specify the following:

\n \n

If successful, a new game session placement is created.

\n

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the\n status is FULFILLED, a new game session has been created and a game session\n ARN and Region are referenced. If the placement request times out, you can resubmit the\n request or retry it with a different queue.

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Places a request for a new game session in a queue. When processing a placement\n request, Amazon GameLift searches for available resources on the queue's destinations, scanning\n each until it finds resources or the placement request times out.

\n

A game session placement request can also request player sessions. When a new game\n session is successfully created, Amazon GameLift creates a player session for each player\n included in the request.

\n

When placing a game session, by default Amazon GameLift tries each fleet in the order they are\n listed in the queue configuration. Ideally, a queue's destinations are listed in\n preference order.

\n

Alternatively, when requesting a game session with players, you can also provide\n latency data for each player in relevant Regions. Latency data indicates the performance\n lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency\n data to reorder the list of destinations to place the game session in a Region with\n minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each\n Region's average lag for all players and reorders to get the best game play across all\n players.

\n

To place a new game session request, specify the following:

\n \n

If successful, a new game session placement is created.

\n

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status\n is FULFILLED, a new game session has been created and a game session ARN\n and Region are referenced. If the placement request times out, you can resubmit the\n request or retry it with a different queue.

" } }, "com.amazonaws.gamelift#StartGameSessionPlacementInput": { @@ -10681,21 +13573,21 @@ "PlacementId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier to assign to the new game session placement. This value is\n developer-defined. The value must be unique across all Regions and cannot be reused\n unless you are resubmitting a canceled or timed-out placement request.

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

A unique identifier to assign to the new game session placement. This value is\n developer-defined. The value must be unique across all Regions and cannot be\n reused.

", "smithy.api#required": {} } }, "GameSessionQueueName": { "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArn", "traits": { - "smithy.api#documentation": "

Name of the queue to use to place the new game session. You can use either the queue name\n or ARN value.

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

Name of the queue to use to place the new game session. You can use either the queue\n name or ARN value.

", "smithy.api#required": {} } }, "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).

" } }, "MaximumPlayerSessionCount": { @@ -10714,7 +13606,7 @@ "PlayerLatencies": { "target": "com.amazonaws.gamelift#PlayerLatencyList", "traits": { - "smithy.api#documentation": "

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. This information is used to try to place the new game session where\n it can offer the best possible gameplay experience for the players.

" + "smithy.api#documentation": "

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it\n can offer the best possible gameplay experience for the players.

" } }, "DesiredPlayerSessions": { @@ -10726,12 +13618,9 @@ "GameSessionData": { "target": "com.amazonaws.gamelift#LargeGameSessionData", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StartGameSessionPlacementOutput": { @@ -10740,12 +13629,9 @@ "GameSessionPlacement": { "target": "com.amazonaws.gamelift#GameSessionPlacement", "traits": { - "smithy.api#documentation": "

Object that describes the newly created game session placement. This object\n includes all the information provided in the request, as well as start/end time stamps\n and placement status.

" + "smithy.api#documentation": "

Object that describes the newly created game session placement. This object includes\n all the information provided in the request, as well as start/end time stamps and\n placement status.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StartMatchBackfill": { @@ -10771,7 +13657,7 @@ } ], "traits": { - "smithy.api#documentation": "

Finds new players to fill open slots in currently running game sessions. \n The backfill match process is essentially identical to the process of forming new\n matches. Backfill\n requests use the same matchmaker that was used to make the original match, and they provide\n matchmaking data for all players currently in the game session. FlexMatch uses this information \n to select new players so that backfilled match continues to meet the original match requirements.

\n

When using FlexMatch with GameLift managed hosting, you can request a backfill match from\n a client service by calling this operation with a GameSession\n identifier. You also have the option of making backfill requests directly from your game\n server. In response to a request, FlexMatch creates player sessions for the new players,\n updates the GameSession resource, and sends updated matchmaking data to the\n game server. You can request a backfill match at any point after a game session is\n started. Each game session can have only one active backfill request at a time; a\n subsequent request automatically replaces the earlier request.

\n

When using FlexMatch as a standalone component, request a backfill match by calling this operation\n without a game session identifier. As with newly formed matches, matchmaking results are returned\n in a matchmaking event so that your game can update the game session that is being backfilled.

\n

To request a backfill match, specify a unique ticket ID, the original matchmaking\n configuration, and matchmaking data for all current players in the game session being\n backfilled. Optionally, specify the GameSession ARN. If successful, a match\n backfill ticket is created and returned with status set to QUEUED. Track the status of\n backfill tickets using the same method for tracking tickets for new matches.

\n

Only game sessions created by FlexMatch are supported for match backfill.

\n

\n Learn more\n

\n

\n \n Backfill existing games with FlexMatch\n

\n

\n \n Matchmaking events (reference)

\n

\n \n How GameLift FlexMatch works\n

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" + "smithy.api#documentation": "

Finds new players to fill open slots in currently running game sessions. The backfill\n match process is essentially identical to the process of forming new matches. Backfill\n requests use the same matchmaker that was used to make the original match, and they\n provide matchmaking data for all players currently in the game session. FlexMatch uses\n this information to select new players so that backfilled match continues to meet the\n original match requirements.

\n

When using FlexMatch with GameLift managed hosting, you can request a backfill match from\n a client service by calling this operation with a GameSessions ID. You also\n have the option of making backfill requests directly from your game server. In response\n to a request, FlexMatch creates player sessions for the new players, updates the\n GameSession resource, and sends updated matchmaking data to the game\n server. You can request a backfill match at any point after a game session is started.\n Each game session can have only one active backfill request at a time; a subsequent\n request automatically replaces the earlier request.

\n

When using FlexMatch as a standalone component, request a backfill match by calling this\n operation without a game session identifier. As with newly formed matches, matchmaking\n results are returned in a matchmaking event so that your game can update the game\n session that is being backfilled.

\n

To request a backfill match, specify a unique ticket ID, the original matchmaking\n configuration, and matchmaking data for all current players in the game session being\n backfilled. Optionally, specify the GameSession ARN. If successful, a match\n backfill ticket is created and returned with status set to QUEUED. Track the status of\n backfill tickets using the same method for tracking tickets for new matches.

\n

Only game sessions created by FlexMatch are supported for match backfill.

\n

\n Learn more\n

\n

\n \n Backfill existing games with FlexMatch\n

\n

\n \n Matchmaking events (reference)

\n

\n \n How GameLift FlexMatch works\n

" } }, "com.amazonaws.gamelift#StartMatchBackfillInput": { @@ -10780,13 +13666,13 @@ "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the match backfill ticket status and retrieve match\n results.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a\n UUID. Use this identifier to track the match backfill ticket status and retrieve match\n results.

" } }, "ConfigurationName": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { - "smithy.api#documentation": "

Name of the matchmaker to use for this request. You can use either the configuration\n name or ARN value. The ARN of the matchmaker that was used with the original game\n session is listed in the GameSession object,\n MatchmakerData property.

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

Name of the matchmaker to use for this request. You can use either the configuration\n name or ARN value. The ARN of the matchmaker that was used with the original game\n session is listed in the GameSession object, MatchmakerData\n property.

", "smithy.api#required": {} } }, @@ -10799,13 +13685,10 @@ "Players": { "target": "com.amazonaws.gamelift#PlayerList", "traits": { - "smithy.api#documentation": "

Match information on all players that are currently assigned to the game session.\n This information is used by the matchmaker to find new players and add them to the\n existing game.

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

Match information on all players that are currently assigned to the game session. This\n information is used by the matchmaker to find new players and add them to the existing\n game.

\n

You can include up to 199 Players in a StartMatchBackfill\n request.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StartMatchBackfillOutput": { @@ -10817,9 +13700,6 @@ "smithy.api#documentation": "

Ticket representing the backfill matchmaking request. This object includes the\n information in the request, ticket status, and match results as generated during the\n matchmaking process.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StartMatchmaking": { @@ -10845,7 +13725,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uses FlexMatch to create a game match for a group of players based on custom matchmaking\n rules. With games that use GameLift managed hosting, this operation also triggers GameLift\n to find hosting resources and start a new game session for the new match. Each\n matchmaking request includes information on one or more players and specifies the\n FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to\n build a match that includes all players in the request, placing them in the same team\n and finding additional players as needed to fill the match.

\n

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,\n and include the players to be matched. You must also include any player attributes that\n are required by the matchmaking configuration's rule set. If successful, a matchmaking\n ticket is returned with status set to QUEUED.

\n

Track matchmaking events to respond as needed and acquire game session connection\n information for successfully completed matches. Ticket status updates are tracked using\n event notification through Amazon Simple Notification Service, which is defined in the matchmaking\n configuration.

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n \n Set Up FlexMatch event notification\n

\n

\n \n How GameLift FlexMatch works\n

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" + "smithy.api#documentation": "

Uses FlexMatch to create a game match for a group of players based on custom matchmaking\n rules. With games that use GameLift managed hosting, this operation also triggers GameLift\n to find hosting resources and start a new game session for the new match. Each\n matchmaking request includes information on one or more players and specifies the\n FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to\n build a match that includes all players in the request, placing them in the same team\n and finding additional players as needed to fill the match.

\n

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,\n and include the players to be matched. You must also include any player attributes that\n are required by the matchmaking configuration's rule set. If successful, a matchmaking\n ticket is returned with status set to QUEUED.

\n

Track matchmaking events to respond as needed and acquire game session connection\n information for successfully completed matches. Ticket status updates are tracked using\n event notification through Amazon Simple Notification Service, which is defined in the matchmaking\n configuration.

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n Set Up FlexMatch event\n notification\n

\n

\n \n How GameLift FlexMatch works\n

" } }, "com.amazonaws.gamelift#StartMatchmakingInput": { @@ -10854,7 +13734,7 @@ "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the matchmaking ticket status and retrieve match\n results.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a\n UUID. Use this identifier to track the matchmaking ticket status and retrieve match\n results.

" } }, "ConfigurationName": { @@ -10867,13 +13747,10 @@ "Players": { "target": "com.amazonaws.gamelift#PlayerList", "traits": { - "smithy.api#documentation": "

Information on each player to be matched. This information must include a player\n ID, and may contain player attributes and latency data to be used in the matchmaking\n process. After a successful match, Player objects contain the name of the\n team the player is assigned to.

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

Information on each player to be matched. This information must include a player ID,\n and may contain player attributes and latency data to be used in the matchmaking\n process. After a successful match, Player objects contain the name of the\n team the player is assigned to.

\n

You can include up to 10 Players in a StartMatchmaking\n request.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StartMatchmakingOutput": { @@ -10885,9 +13762,6 @@ "smithy.api#documentation": "

Ticket representing the matchmaking request. This object include the information\n included in the request, ticket status, and match results as generated during the\n matchmaking process.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StopFleetActions": { @@ -10916,7 +13790,7 @@ } ], "traits": { - "smithy.api#documentation": "

Suspends certain types of activity in a fleet location. Currently, this operation is\n used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed\n separately for each location.

\n

Stopping fleet actions has several potential purposes. It allows you to temporarily\n stop auto-scaling activity but retain your scaling policies for use in the future. For\n multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it\n for certain locations.

\n

This operation can be used in the following ways:

\n \n

If successful, GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity. You can view a fleet's stopped\n actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended activity can be restarted\n using StartFleetActions.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related actions\n

\n

\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n

" + "smithy.api#documentation": "

Suspends certain types of activity in a fleet location. Currently, this operation is\n used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed\n separately for each location.

\n

Stopping fleet actions has several potential purposes. It allows you to temporarily\n stop auto-scaling activity but retain your scaling policies for use in the future. For\n multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it\n for certain locations.

\n

This operation can be used in the following ways:

\n \n

If successful, GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity.

\n

\n Learn more\n

\n

\n Setting up GameLift\n Fleets\n

" } }, "com.amazonaws.gamelift#StopFleetActionsInput": { @@ -10925,7 +13799,7 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.

", "smithy.api#required": {} } }, @@ -10939,12 +13813,9 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as\n us-west-2.

" + "smithy.api#documentation": "

The fleet location to stop fleet actions for. Specify a location in the form of an\n Amazon Web Services Region code, such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StopFleetActionsOutput": { @@ -10962,9 +13833,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StopGameSessionPlacement": { @@ -10990,7 +13858,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a game session placement that is in PENDING status. To stop a\n placement, provide the placement ID values. If successful, the placement is moved to\n CANCELLED status.

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Cancels a game session placement that is in PENDING status. To stop a\n placement, provide the placement ID values. If successful, the placement is moved to\n CANCELLED status.

" } }, "com.amazonaws.gamelift#StopGameSessionPlacementInput": { @@ -10999,13 +13867,10 @@ "PlacementId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a game session placement to cancel.

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

A unique identifier for a game session placement to stop.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StopGameSessionPlacementOutput": { @@ -11014,12 +13879,9 @@ "GameSessionPlacement": { "target": "com.amazonaws.gamelift#GameSessionPlacement", "traits": { - "smithy.api#documentation": "

Object that describes the canceled game session placement, with\n CANCELLED status and an end time stamp.

" + "smithy.api#documentation": "

Object that describes the canceled game session placement, with CANCELLED\n status and an end time stamp.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StopMatchmaking": { @@ -11045,7 +13907,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a matchmaking ticket or match backfill ticket that is currently being\n processed. To stop the matchmaking operation, specify the ticket ID. If successful, work\n on the ticket is stopped, and the ticket status is changed to\n CANCELLED.

\n

This call is also used to turn off automatic backfill for an individual game session.\n This is for game sessions that are created with a matchmaking configuration that has\n automatic backfill enabled. The ticket ID is included in the MatchmakerData\n of an updated game session object, which is provided to the game server.

\n \n

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response\n (not an empty HTTP body).

\n \n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" + "smithy.api#documentation": "

Cancels a matchmaking ticket or match backfill ticket that is currently being\n processed. To stop the matchmaking operation, specify the ticket ID. If successful, work\n on the ticket is stopped, and the ticket status is changed to\n CANCELLED.

\n

This call is also used to turn off automatic backfill for an individual game session.\n This is for game sessions that are created with a matchmaking configuration that has\n automatic backfill enabled. The ticket ID is included in the MatchmakerData\n of an updated game session object, which is provided to the game server.

\n \n

If the operation is successful, the service sends back an empty JSON struct with\n the HTTP 200 response (not an empty HTTP body).

\n \n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

" } }, "com.amazonaws.gamelift#StopMatchmakingInput": { @@ -11058,24 +13920,12 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StopMatchmakingOutput": { "type": "structure", "members": {} }, - "com.amazonaws.gamelift#StringDoubleMap": { - "type": "map", - "key": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString" - }, - "value": { - "target": "com.amazonaws.gamelift#DoubleObject" - } - }, "com.amazonaws.gamelift#StringList": { "type": "list", "member": { @@ -11108,7 +13958,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Temporarily stops activity on a game server group without terminating instances or the\n game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

\n \n

To suspend activity, specify a game server group ARN and the type of activity to be\n suspended. If successful, a GameServerGroup object is returned showing\n that the activity is listed in SuspendedActions.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Temporarily stops activity on\n a game server group without terminating instances or the game server group. You can\n restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

\n \n

To suspend activity, specify a game server group ARN and the type of activity to be\n suspended. If successful, a GameServerGroup object is returned showing that\n the activity is listed in SuspendedActions.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#SuspendGameServerGroupInput": { @@ -11117,7 +13967,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group. Use either the name or ARN value.

", "smithy.api#required": {} } }, @@ -11147,20 +13997,20 @@ "Key": { "target": "com.amazonaws.gamelift#TagKey", "traits": { - "smithy.api#documentation": "

\n The key for a developer-defined key:value pair for tagging an Amazon Web Services resource.\n

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

The key for a developer-defined key:value pair for tagging an Amazon Web Services resource.

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

\n The value for a developer-defined key:value pair for tagging an Amazon Web Services resource.\n

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

The value for a developer-defined key:value pair for tagging an Amazon Web Services resource.\n

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

\n A label that can be assigned to a GameLift resource.\n

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n

" + "smithy.api#documentation": "

A label that can be assigned to a GameLift resource.

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#TagKey": { @@ -11219,7 +14069,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional\n management tool set. You can use tags to organize resources, create IAM permissions\n policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc.\n This operation handles the permissions necessary to manage tags for the following GameLift\n resource types:

\n \n

To add a tag to a resource, specify the unique ARN value for the resource and provide\n a tag list containing one or more tags. The operation succeeds even if the list includes\n tags that are already assigned to the specified resource.

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n

" + "smithy.api#documentation": "

Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional\n management tool set. You can use tags to organize resources, create IAM permissions\n policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc.\n This operation handles the permissions necessary to manage tags for the following\n GameLift resource types:

\n \n

To add a tag to a resource, specify the unique ARN value for the resource and provide\n a tag list containing one or more tags. The operation succeeds even if the list includes\n tags that are already assigned to the specified resource.

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#TagResourceRequest": { @@ -11228,14 +14078,14 @@ "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to assign\n tags to. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe operation for the resource type.

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

The Amazon Resource Name (ARN) that is assigned to and\n uniquely identifies the GameLift resource that you want to assign tags to. GameLift\n resource ARNs are included in the data object for the resource, which can be retrieved\n by calling a List or Describe operation for the resource type.

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

A list of one or more tags to assign to the specified GameLift resource. \n Tags are developer-defined and structured as key-value pairs. \n The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources \n for actual tagging limits.

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

A list of one or more tags to assign to the specified GameLift resource. Tags are\n developer-defined and structured as key-value pairs. The maximum tag limit may be lower\n than stated. See \n Tagging Amazon Web Services Resources for actual tagging limits.

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

\n The requested tagging operation did not succeed. This may be due to invalid tag format\n or the maximum tag limit may have been exceeded. Resolve the issue before retrying.\n

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

The requested tagging operation did not succeed. This may be due to invalid tag format\n or the maximum tag limit may have been exceeded. Resolve the issue before\n retrying.

", "smithy.api#error": "client" } }, @@ -11272,13 +14122,14 @@ "TargetValue": { "target": "com.amazonaws.gamelift#Double", "traits": { - "smithy.api#documentation": "

Desired value to use with a target-based scaling policy. The value must be relevant\n for whatever metric the scaling policy is using. For example, in a policy using the\n metric PercentAvailableGameSessions, the target value should be the preferred size of\n the fleet's buffer (the percent of capacity that should be idle and ready for new game\n sessions).

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

Desired value to use with a target-based scaling policy. The value must be relevant\n for whatever metric the scaling policy is using. For example, in a policy using the\n metric PercentAvailableGameSessions, the target value should be the preferred size of\n the fleet's buffer (the percent of capacity that should be idle and ready for new game\n sessions).

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

Settings for a target-based scaling policy (see ScalingPolicy. A\n target-based policy tracks a particular fleet metric specifies a target value for the\n metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so\n that the metric returns to the target value. The target configuration specifies settings\n as needed for the target based policy, including the target value.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" + "smithy.api#documentation": "

Settings for a target-based scaling policy. A target-based policy tracks a particular\n fleet metric specifies a target value for the metric. As player usage changes, the\n policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target\n value. The target configuration specifies settings as needed for the target based\n policy, including the target value.

" } }, "com.amazonaws.gamelift#TargetTrackingConfiguration": { @@ -11287,13 +14138,13 @@ "TargetValue": { "target": "com.amazonaws.gamelift#NonNegativeDouble", "traits": { - "smithy.api#documentation": "

Desired value to use with a game server group target-based scaling policy.

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

Desired value to use with a game server group target-based scaling policy.

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy. \n These settings are used to\n create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.

" + "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

Settings for a\n target-based scaling policy as part of a GameServerGroupAutoScalingPolicy . These settings are used to create a\n target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.

" } }, "com.amazonaws.gamelift#TerminalRoutingStrategyException": { @@ -11304,7 +14155,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service is unable to resolve the routing for a particular alias because it has\n a terminal RoutingStrategy associated with it. The message returned in\n this exception is the message defined in the routing strategy itself. Such requests\n should only be retried if the routing strategy for the specified alias is modified.\n

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

The service is unable to resolve the routing for a particular alias because it has a\n terminal RoutingStrategy associated with it. The message returned in this\n exception is the message defined in the routing strategy itself. Such requests should\n only be retried if the routing strategy for the specified alias is modified.

", "smithy.api#error": "client" } }, @@ -11358,7 +14209,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a tag that is assigned to a GameLift resource. \n Resource tags are used to organize Amazon Web Services resources for a range of purposes. \n This operation handles the permissions necessary to manage tags for the following \n GameLift resource types:

\n \n

To remove a tag from a resource, specify the unique ARN value for the resource and provide\n a string list containing one or more tags to be removed. \n This operation succeeds even if the list includes tags that are not currently assigned to the\n specified resource.

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n

" + "smithy.api#documentation": "

Removes a tag that is assigned to a GameLift resource. Resource tags are used to\n organize Amazon Web Services resources for a range of purposes. This operation handles the permissions\n necessary to manage tags for the following GameLift resource types:

\n \n

To remove a tag from a resource, specify the unique ARN value for the resource and\n provide a string list containing one or more tags to be removed. This operation succeeds\n even if the list includes tags that are not currently assigned to the specified\n resource.

\n

\n Learn more\n

\n

\n Tagging Amazon Web Services\n Resources in the Amazon Web Services General Reference\n

\n

\n \n Amazon Web Services Tagging Strategies\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#UntagResourceRequest": { @@ -11407,7 +14258,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates properties for an alias. To update properties, specify the alias ID to be\n updated and provide the information to be changed. To reassign an alias to another\n fleet, provide an updated routing strategy. If successful, the updated alias record is\n returned.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates properties for an alias. To update properties, specify the alias ID to be\n updated and provide the information to be changed. To reassign an alias to another\n fleet, provide an updated routing strategy. If successful, the updated alias record is\n returned.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#UpdateAliasInput": { @@ -11438,9 +14289,6 @@ "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the\n alias.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateAliasOutput": { @@ -11452,9 +14300,6 @@ "smithy.api#documentation": "

The updated alias resource.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateBuild": { @@ -11480,7 +14325,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates metadata in a build resource, including the build name and version. To update\n the metadata, specify the build ID to update and provide the new values. If successful,\n a build object containing the updated metadata is returned.

\n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates metadata in a build resource, including the build name and version. To update\n the metadata, specify the build ID to update and provide the new values. If successful,\n a build object containing the updated metadata is returned.

\n

\n Learn more\n

\n

\n Upload a Custom\n Server Build\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#UpdateBuildInput": { @@ -11489,25 +14334,22 @@ "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the build to update. You can use either the build ID or ARN value.

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

A unique identifier for the build to update. You can use either the build ID or ARN value.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique.

" + "smithy.api#documentation": "

A descriptive label associated with a build. Build names do not need to be unique.

" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique.

" + "smithy.api#documentation": "

Version information associated with a build or script. Version strings do not need to be unique.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateBuildOutput": { @@ -11519,9 +14361,6 @@ "smithy.api#documentation": "

The updated build resource.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetAttributes": { @@ -11556,7 +14395,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a fleet's mutable attributes, including game session protection and resource\n creation limits.

\n

To update fleet attributes, specify the fleet ID and the property values that you want\n to change.

\n

If successful, an updated FleetAttributes object is returned.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates a fleet's mutable attributes, including game session protection and resource\n creation limits.

\n

To update fleet attributes, specify the fleet ID and the property values that you want\n to change.

\n

If successful, an updated FleetAttributes object is returned.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#UpdateFleetAttributesInput": { @@ -11584,7 +14423,7 @@ "NewGameSessionProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "

The game session protection policy to apply to all new instances created in this\n fleet. Instances that already exist are not affected. You can set protection for\n individual instances using UpdateGameSession.

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

The game session protection policy to apply to all new instances created in this\n fleet. Instances that already exist are not affected. You can set protection for\n individual instances using UpdateGameSession .

\n " } }, "ResourceCreationLimitPolicy": { @@ -11598,10 +14437,13 @@ "traits": { "smithy.api#documentation": "

The name of a metric group to add this fleet to. Use a metric group in Amazon\n CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric\n group name, or create a new metric group by providing a new name. A fleet can only be in\n one metric group at a time.

" } + }, + "AnywhereConfiguration": { + "target": "com.amazonaws.gamelift#AnywhereConfiguration", + "traits": { + "smithy.api#documentation": "

GameLift Anywhere configuration options.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetAttributesOutput": { @@ -11612,10 +14454,13 @@ "traits": { "smithy.api#documentation": "

A unique identifier for the fleet that was updated.

" } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetCapacity": { @@ -11653,7 +14498,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates capacity settings for a fleet. For fleets with multiple locations, use this\n operation to manage capacity settings in each location individually. Fleet capacity\n determines the number of game sessions and players that can be hosted based on the fleet\n configuration. Use this operation to set the following fleet capacity properties:

\n \n

This operation can be used in the following ways:

\n \n

If successful, capacity settings are updated immediately. In response a change in\n desired capacity, GameLift initiates steps to start new instances or terminate existing\n instances in the requested fleet location. This continues until the location's active\n instance count matches the new desired instance count. You can track a fleet's current\n capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count\n is higher than the instance type's limit, the LimitExceeded exception\n occurs.

\n

\n Learn more\n

\n

\n Scaling fleet capacity\n

\n

\n Related actions\n

\n

\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates capacity settings for a fleet. For fleets with multiple locations, use this\n operation to manage capacity settings in each location individually. Fleet capacity\n determines the number of game sessions and players that can be hosted based on the fleet\n configuration. Use this operation to set the following fleet capacity properties:

\n \n

This operation can be used in the following ways:

\n \n

If successful, capacity settings are updated immediately. In response a change in\n desired capacity, GameLift initiates steps to start new instances or terminate existing\n instances in the requested fleet location. This continues until the location's active\n instance count matches the new desired instance count. You can track a fleet's current\n capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is\n higher than the instance type's limit, the LimitExceeded exception\n occurs.

\n

\n Learn more\n

\n

\n Scaling fleet\n capacity\n

" } }, "com.amazonaws.gamelift#UpdateFleetCapacityInput": { @@ -11690,9 +14535,6 @@ "smithy.api#documentation": "

The name of a remote location to update fleet capacity settings for, in the form of an\n Amazon Web Services Region code such as us-west-2.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetCapacityOutput": { @@ -11713,12 +14555,9 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The remote location being updated, expressed as an Amazon Web Services Region code, \n such as us-west-2.

" + "smithy.api#documentation": "

The remote location being updated, expressed as an Amazon Web Services Region code, such as\n us-west-2.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetPortSettings": { @@ -11753,7 +14592,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates permissions that allow inbound traffic to connect to game sessions that are\n being hosted on instances in the fleet.

\n

To update settings, specify the fleet ID to be updated and specify the changes to be\n made. List the permissions you want to add in\n InboundPermissionAuthorizations, and permissions you want to remove in\n InboundPermissionRevocations. Permissions to be removed must match\n existing fleet permissions.

\n

If successful, the fleet ID for the updated fleet is returned. For fleets with remote\n locations, port setting updates can take time to propagate across all locations. You can\n check the status of updates in each location by calling\n DescribeFleetPortSettings with a location name.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates permissions that allow inbound traffic to connect to game sessions that are\n being hosted on instances in the fleet.

\n

To update settings, specify the fleet ID to be updated and specify the changes to be\n made. List the permissions you want to add in\n InboundPermissionAuthorizations, and permissions you want to remove in\n InboundPermissionRevocations. Permissions to be removed must match\n existing fleet permissions.

\n

If successful, the fleet ID for the updated fleet is returned. For fleets with remote\n locations, port setting updates can take time to propagate across all locations. You can\n check the status of updates in each location by calling\n DescribeFleetPortSettings with a location name.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#UpdateFleetPortSettingsInput": { @@ -11778,9 +14617,6 @@ "smithy.api#documentation": "

A collection of port settings to be removed from the fleet resource.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetPortSettingsOutput": { @@ -11791,10 +14627,13 @@ "traits": { "smithy.api#documentation": "

A unique identifier for the fleet that was updated.

" } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameServer": { @@ -11820,7 +14659,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Updates information about a registered game server to help GameLift FleetIQ to track game server\n availability. This operation is called by a game server process that is running on an\n instance in a game server group.

\n

Use this operation to update the following types of game server information. You can\n make all three types of updates in the same request:

\n \n

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related actions\n

\n

\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Updates information about a\n registered game server to help GameLift FleetIQ to track game server availability. This operation\n is called by a game server process that is running on an instance in a game server\n group.

\n

Use this operation to update the following types of game server information. You can\n make all three types of updates in the same request:

\n \n

Once a game server is successfully updated, the relevant statuses and timestamps are\n updated.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#UpdateGameServerGroup": { @@ -11846,7 +14685,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group\n properties are updated on the Auto Scaling group directly, including the launch\n template, Auto Scaling policies, and maximum/minimum/desired instance counts.

\n

To update the game server group, specify the game server group ID and provide the\n updated values. Before applying the updates, the new values are validated to ensure that\n GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n \n

\n Related actions\n

\n

\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n

" + "smithy.api#documentation": "

\n This operation is used with the GameLift FleetIQ solution and game server groups.\n

\n

Updates GameLift FleetIQ-specific\n properties for a game server group. Many Auto Scaling group properties are updated on\n the Auto Scaling group directly, including the launch template, Auto Scaling policies,\n and maximum/minimum/desired instance counts.

\n

To update the game server group, specify the game server group ID and provide the\n updated values. Before applying the updates, the new values are validated to ensure that\n GameLift FleetIQ can continue to perform instance balancing activity. If successful, a\n GameServerGroup object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ\n Guide\n

" } }, "com.amazonaws.gamelift#UpdateGameServerGroupInput": { @@ -11855,7 +14694,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group. Use either the name or ARN value.

", "smithy.api#required": {} } }, @@ -11891,7 +14730,7 @@ "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { - "smithy.api#documentation": "

An object that describes the game server group resource with updated properties.

" + "smithy.api#documentation": "

An object that describes the game server group resource with updated properties.\n

" } } } @@ -11902,7 +14741,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group where the game server is running.

", "smithy.api#required": {} } }, @@ -11916,7 +14755,7 @@ "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers.

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

Updates the mutable properties of a game session.

\n

To update a game session, specify the game session ID and the values you want to\n change.

\n

If successful, the updated GameSession object is returned.

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates the mutable properties of a game session.

\n

To update a game session, specify the game session ID and the values you want to\n change.

\n

If successful, the updated GameSession object is returned.

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#UpdateGameSessionInput": { @@ -12007,12 +14846,9 @@ "ProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "

Game session protection policy to apply to this game session only.

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

Game session protection policy to apply to this game session only.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameSessionOutput": { @@ -12024,9 +14860,6 @@ "smithy.api#documentation": "

The updated game session properties.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameSessionQueue": { @@ -12052,7 +14885,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration of a game session queue, which determines how the queue\n processes new game session requests. To update settings, specify the queue name to be\n updated and provide the new settings. When updating destinations, provide a complete\n list of destinations.

\n

\n Learn more\n

\n

\n \n Using Multi-Region Queues\n

\n

\n Related actions\n

\n

\n CreateGameSessionQueue \n |\n DescribeGameSessionQueues\n | \n UpdateGameSessionQueue\n | \n DeleteGameSessionQueue\n | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates the configuration of a game session queue, which determines how the queue\n processes new game session requests. To update settings, specify the queue name to be\n updated and provide the new settings. When updating destinations, provide a complete\n list of destinations.

\n

\n Learn more\n

\n

\n \n Using Multi-Region Queues\n

" } }, "com.amazonaws.gamelift#UpdateGameSessionQueueInput": { @@ -12074,7 +14907,7 @@ "PlayerLatencyPolicies": { "target": "com.amazonaws.gamelift#PlayerLatencyPolicyList", "traits": { - "smithy.api#documentation": "

A set of policies that act as a sliding cap on player latency. FleetIQ works to\n deliver low latency for most players in a game session. These policies ensure that no\n individual player can be placed into a game with unreasonably high latency. Use multiple\n policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their\n maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of\n policies.

" + "smithy.api#documentation": "

A set of policies that act as a sliding cap on player latency. FleetIQ works to\n deliver low latency for most players in a game session. These policies ensure that no\n individual player can be placed into a game with unreasonably high latency. Use multiple\n policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their\n maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

" } }, "Destinations": { @@ -12098,18 +14931,15 @@ "CustomEventData": { "target": "com.amazonaws.gamelift#QueueCustomEventData", "traits": { - "smithy.api#documentation": "

\n Information to be added to all events that are related to this game session queue.\n

" + "smithy.api#documentation": "

Information to be added to all events that are related to this game session\n queue.

" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#QueueSnsArnStringModel", "traits": { - "smithy.api#documentation": "

An SNS topic ARN that is set up to receive game session placement notifications. See \n Setting up notifications for game session placement.

" + "smithy.api#documentation": "

An SNS topic ARN that is set up to receive game session placement notifications. See\n Setting up\n notifications for game session placement.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameSessionQueueOutput": { @@ -12121,9 +14951,6 @@ "smithy.api#documentation": "

An object that describes the newly updated game session queue.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfiguration": { @@ -12149,7 +14976,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions\n that are created after the update. To update settings,\n specify the configuration name to be updated and provide the new settings.

\n

\n Learn more\n

\n

\n \n Design a FlexMatch matchmaker\n

\n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates settings for a FlexMatch matchmaking configuration. These changes affect all\n matches and game sessions that are created after the update. To update settings, specify\n the configuration name to be updated and provide the new settings.

\n

\n Learn more\n

\n

\n Design a FlexMatch\n matchmaker\n

" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfigurationInput": { @@ -12165,7 +14992,7 @@ "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with matchmaking configuration.

" + "smithy.api#documentation": "

A description for the matchmaking configuration.

" } }, "GameSessionQueueArns": { @@ -12207,7 +15034,7 @@ "AdditionalPlayerCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to\n STANDALONE.

" + "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to\n STANDALONE.

" } }, "CustomEventData": { @@ -12219,30 +15046,27 @@ "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is\n created for a successful match. This parameter is not used if FlexMatchMode\n is set to STANDALONE.

" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object\n that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session\n that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.

" } }, "BackfillMode": { "target": "com.amazonaws.gamelift#BackfillMode", "traits": { - "smithy.api#documentation": "

The method that is used to backfill game sessions created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests manually or does\n not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch. Automatic backfill is not available when\n FlexMatchMode is set to STANDALONE.

" + "smithy.api#documentation": "

The method that is used to backfill game sessions created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests manually or does\n not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill\n request whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch. Automatic backfill is not available when\n FlexMatchMode is set to STANDALONE.

" } }, "FlexMatchMode": { "target": "com.amazonaws.gamelift#FlexMatchMode", "traits": { - "smithy.api#documentation": "

Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.

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

Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfigurationOutput": { @@ -12254,9 +15078,6 @@ "smithy.api#documentation": "

The updated matchmaking configuration.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateRuntimeConfiguration": { @@ -12285,7 +15106,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the current runtime configuration for the specified fleet, which tells GameLift\n how to launch server processes on all instances in the fleet. You can update a fleet's\n runtime configuration at any time after the fleet is created; it does not need to be in\n ACTIVE status.

\n

To update runtime configuration, specify the fleet ID and provide a\n RuntimeConfiguration with an updated set of server process\n configurations.

\n

If successful, the fleet's runtime configuration settings are updated. Each instance\n in the fleet regularly checks for and retrieves updated runtime configurations.\n Instances immediately begin complying with the new configuration by launching new server\n processes or not replacing existing processes when they shut down. Updating a fleet's\n runtime configuration never affects existing server processes.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n

\n Related actions\n

\n

\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates the current runtime configuration for the specified fleet, which tells GameLift\n how to launch server processes on all instances in the fleet. You can update a fleet's\n runtime configuration at any time after the fleet is created; it does not need to be in\n ACTIVE status.

\n

To update runtime configuration, specify the fleet ID and provide a\n RuntimeConfiguration with an updated set of server process\n configurations.

\n

If successful, the fleet's runtime configuration settings are updated. Each instance\n in the fleet regularly checks for and retrieves updated runtime configurations.\n Instances immediately begin complying with the new configuration by launching new server\n processes or not replacing existing processes when they shut down. Updating a fleet's\n runtime configuration never affects existing server processes.

\n

\n Learn more\n

\n

\n Setting up GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#UpdateRuntimeConfigurationInput": { @@ -12301,13 +15122,10 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "

Instructions for launching server processes on each instance in the fleet. Server\n processes run either a custom game build executable or a Realtime Servers script. The runtime\n configuration lists the types of server processes to run on an instance, how to launch\n them, and the number of processes to run concurrently.

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

Instructions for alaunching server processes on each instance in the fleet. Server\n processes run either a custom game build executable or a Realtime Servers script. The runtime\n configuration lists the types of server processes to run on an instance, how to launch\n them, and the number of processes to run concurrently.

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

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateRuntimeConfigurationOutput": { @@ -12319,9 +15137,6 @@ "smithy.api#documentation": "

The runtime configuration currently in use by all instances in the fleet. If the\n update was successful, all property changes are shown.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateScript": { @@ -12347,7 +15162,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates Realtime script metadata and content.

\n

To update script metadata, specify the script ID and provide updated name and/or\n version values.

\n

To update script content, provide an updated zip file by pointing to either a local\n file or an Amazon S3 bucket location. You can use either method regardless of how the\n original script was uploaded. Use the Version parameter to track\n updates to the script.

\n

If the call is successful, the updated metadata is stored in the script record and a\n revised script is uploaded to the Amazon GameLift service. Once the script is updated and\n acquired by a fleet instance, the new version is used for all new game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates Realtime script metadata and content.

\n

To update script metadata, specify the script ID and provide updated name and/or\n version values.

\n

To update script content, provide an updated zip file by pointing to either a local\n file or an Amazon S3 bucket location. You can use either method regardless of how the\n original script was uploaded. Use the Version parameter to track\n updates to the script.

\n

If the call is successful, the updated metadata is stored in the script record and a\n revised script is uploaded to the Amazon GameLift service. Once the script is updated and\n acquired by a fleet instance, the new version is used for all new game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#UpdateScriptInput": { @@ -12369,7 +15184,7 @@ "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique.

" + "smithy.api#documentation": "

Version information associated with a build or script. Version strings do not need to be unique.

" } }, "StorageLocation": { @@ -12381,7 +15196,7 @@ "ZipFile": { "target": "com.amazonaws.gamelift#ZipBlob", "traits": { - "smithy.api#documentation": "

A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.

\n

When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file\n name. It must be prepended with the string \"fileb://\" to indicate that the file data is\n a binary object. For example: --zip-file\n fileb://myRealtimeScript.zip.

" + "smithy.api#documentation": "

A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.

\n

When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip\n file name. It must be prepended with the string \"fileb://\" to indicate that the file\n data is a binary object. For example: --zip-file\n fileb://myRealtimeScript.zip.

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

Validates the syntax of a matchmaking rule or rule set. This operation checks that\n the rule set is using syntactically correct JSON and that it conforms to allowed\n property expressions. To validate syntax, provide a rule set JSON string.

\n

\n Learn more\n

\n \n

\n Related actions\n

\n

\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n

" + "smithy.api#documentation": "

Validates the syntax of a matchmaking rule or rule set. This operation checks that the\n rule set is using syntactically correct JSON and that it conforms to allowed property\n expressions. To validate syntax, provide a rule set JSON string.

\n

\n Learn more\n

\n " } }, "com.amazonaws.gamelift#ValidateMatchmakingRuleSetInput": { @@ -12430,9 +15245,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ValidateMatchmakingRuleSetOutput": { @@ -12444,9 +15256,6 @@ "smithy.api#documentation": "

A response indicating whether the rule set is valid.

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

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#VpcPeeringAuthorization": { @@ -12461,7 +15270,7 @@ "PeerVpcAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The authorization's peer VPC Amazon Web Services account ID.

" } }, "PeerVpcId": { @@ -12484,7 +15293,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an authorization for a VPC peering connection between the VPC for an\n Amazon GameLift fleet and another VPC on an account you have access to. This authorization\n must exist and be valid for the peering connection to be established. Authorizations are\n valid for 24 hours after they are issued.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Represents an authorization for a VPC peering connection between the VPC for an\n Amazon GameLift fleet and another VPC on an account you have access to. This authorization\n must exist and be valid for the peering connection to be established. Authorizations are\n valid for 24 hours after they are issued.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#VpcPeeringAuthorizationList": { @@ -12505,25 +15314,25 @@ "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.

" } }, "IpV4CidrBlock": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

CIDR block of IPv4 addresses assigned to the VPC peering connection for the\n GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these\n blocks cannot overlap or the peering connection cannot be created.

" + "smithy.api#documentation": "

CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift\n VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot\n overlap or the peering connection cannot be created.

" } }, "VpcPeeringConnectionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier that is automatically assigned to the connection record. This ID\n is referenced in VPC peering connection events, and is used when deleting a connection\n with DeleteVpcPeeringConnection.

" + "smithy.api#documentation": "

A unique identifier that is automatically assigned to the connection record. This ID\n is referenced in VPC peering connection events, and is used when deleting a\n connection.

" } }, "Status": { "target": "com.amazonaws.gamelift#VpcPeeringConnectionStatus", "traits": { - "smithy.api#documentation": "

The status information about the connection. Status indicates if a\n connection is pending, successful, or failed.

" + "smithy.api#documentation": "

The status information about the connection. Status indicates if a connection is\n pending, successful, or failed.

" } }, "PeerVpcId": { @@ -12535,12 +15344,12 @@ "GameLiftVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for the VPC that contains the Amazon GameLift fleet for this\n connection. This VPC is managed by Amazon GameLift and does not appear in your Amazon Web Services account.\n

" + "smithy.api#documentation": "

A unique identifier for the VPC that contains the Amazon GameLift fleet for this connection.\n This VPC is managed by Amazon GameLift and does not appear in your Amazon Web Services account.

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

Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the\n VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a\n pending connection that has not yet been established.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the\n VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a\n pending connection that has not yet been established.

\n

\n Related actions\n

\n

\n All APIs by task\n

" } }, "com.amazonaws.gamelift#VpcPeeringConnectionList": { @@ -12566,7 +15375,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents status information for a VPC peering connection. Status is associated\n with a VpcPeeringConnection object. Status codes and messages are\n provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also\n communicated as a fleet Event.

" + "smithy.api#documentation": "

Represents status information for a VPC peering connection. Status codes and messages\n are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also\n communicated as a fleet event.

" } }, "com.amazonaws.gamelift#VpcSubnet": { @@ -12604,7 +15413,6 @@ "com.amazonaws.gamelift#WholeNumber": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } diff --git a/codegen/sdk-codegen/aws-models/pipes.json b/codegen/sdk-codegen/aws-models/pipes.json new file mode 100644 index 00000000000..c1612768ed0 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/pipes.json @@ -0,0 +1,5098 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.pipes#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + } + }, + "com.amazonaws.pipes#ArnOrJsonPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.pipes#ArnOrUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + } + }, + "com.amazonaws.pipes#AssignPublicIp": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.pipes#AwsVpcConfiguration": { + "type": "structure", + "members": { + "Subnets": { + "target": "com.amazonaws.pipes#Subnets", + "traits": { + "smithy.api#documentation": "

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

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

Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many \n as five security groups. If you do not specify a security group, the default security group for the VPC is used.

" + } + }, + "AssignPublicIp": { + "target": "com.amazonaws.pipes#AssignPublicIp", + "traits": { + "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when \n LaunchType in EcsParameters is set to FARGATE.

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

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. \n This structure is relevant only for ECS tasks that use the awsvpc network mode.

" + } + }, + "com.amazonaws.pipes#BatchArrayProperties": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.pipes#BatchArraySize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the array, if this is an array batch job.

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

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. \n If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

" + } + }, + "com.amazonaws.pipes#BatchArraySize": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 2, + "max": 10000 + } + } + }, + "com.amazonaws.pipes#BatchContainerOverrides": { + "type": "structure", + "members": { + "Command": { + "target": "com.amazonaws.pipes#StringList", + "traits": { + "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker image or the task definition.

" + } + }, + "Environment": { + "target": "com.amazonaws.pipes#BatchEnvironmentVariableList", + "traits": { + "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing \n environment variables from the Docker image or the task definition.

\n \n

Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.

\n " + } + }, + "InstanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The instance type to use for a multi-node parallel job.

\n \n

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

\n " + } + }, + "ResourceRequirements": { + "target": "com.amazonaws.pipes#BatchResourceRequirementsList", + "traits": { + "smithy.api#documentation": "

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, \n and VCPU.

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

The overrides that are sent to a container.

" + } + }, + "com.amazonaws.pipes#BatchDependsOn": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#BatchJobDependency" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.pipes#BatchEnvironmentVariable": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the environment variable.

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

The value of the key-value pair. For environment variables, this is the value of the environment variable.

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

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing \n environment variables from the Docker image or the task definition.

\n \n

Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.

\n " + } + }, + "com.amazonaws.pipes#BatchEnvironmentVariableList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#BatchEnvironmentVariable" + } + }, + "com.amazonaws.pipes#BatchJobDependency": { + "type": "structure", + "members": { + "JobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job ID of the Batch job that's associated with this dependency.

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

The type of the job dependency.

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

An object that represents an Batch job dependency.

" + } + }, + "com.amazonaws.pipes#BatchJobDependencyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "N_TO_N", + "name": "N_TO_N" + }, + { + "value": "SEQUENTIAL", + "name": "SEQUENTIAL" + } + ] + } + }, + "com.amazonaws.pipes#BatchParametersMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.pipes#BatchResourceRequirement": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.pipes#BatchResourceRequirementType", + "traits": { + "smithy.api#documentation": "

The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

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

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all\n containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched\n on.

\n \n

GPUs aren't available for jobs that are running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the \n Create a container section of the Docker Remote API \n and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the \n Create a container section of the Docker Remote API and the\n --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n management in the Batch User Guide.

\n \n

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, 4, or 8

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 16384
\n
\n

\n VCPU = 2, 4, or 8

\n
\n
value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
value = 20480, 24576, or 28672
\n
\n

\n VCPU = 4 or 8

\n
\n
value = 36864, 45056, 53248, or 61440
\n
\n

\n VCPU = 8

\n
\n
value = 32768, 40960, 49152, or 57344
\n
\n

\n VCPU = 8 or 16

\n
\n
value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
\n
\n

\n VCPU = 16

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n \n Create a container section of the Docker Remote API \n and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about\n Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

\n

For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value.\n The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

\n
\n
value = 8
\n
\n

\n MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n

\n
\n
value = 16
\n
\n

\n MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n

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

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

" + } + }, + "com.amazonaws.pipes#BatchResourceRequirementType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GPU", + "name": "GPU" + }, + { + "value": "MEMORY", + "name": "MEMORY" + }, + { + "value": "VCPU", + "name": "VCPU" + } + ] + } + }, + "com.amazonaws.pipes#BatchResourceRequirementsList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#BatchResourceRequirement" + } + }, + "com.amazonaws.pipes#BatchRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.pipes#BatchRetryStrategy": { + "type": "structure", + "members": { + "Attempts": { + "target": "com.amazonaws.pipes#BatchRetryAttempts", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on \n failure the same number of attempts as the value.

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

The retry strategy that's associated with a job. For more information, see \n Automated job retries in the Batch User Guide.

" + } + }, + "com.amazonaws.pipes#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.pipes#CapacityProvider": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#CapacityProviderStrategy": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#CapacityProviderStrategyItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.pipes#CapacityProviderStrategyItem": { + "type": "structure", + "members": { + "capacityProvider": { + "target": "com.amazonaws.pipes#CapacityProvider", + "traits": { + "smithy.api#documentation": "

The short name of the capacity provider.

", + "smithy.api#required": {} + } + }, + "weight": { + "target": "com.amazonaws.pipes#CapacityProviderStrategyItemWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The weight value designates the relative percentage of the total number of tasks launched\n that should use the specified capacity provider. The weight value is taken into consideration\n after the base value, if defined, is satisfied.

" + } + }, + "base": { + "target": "com.amazonaws.pipes#CapacityProviderStrategyItemBase", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on the specified capacity\n provider. Only one capacity provider in a capacity provider strategy can have a base defined.\n If no value is specified, the default value of 0 is used.

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

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

" + } + }, + "com.amazonaws.pipes#CapacityProviderStrategyItemBase": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.pipes#CapacityProviderStrategyItemWeight": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.pipes#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that caused the exception.

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

The type of resource that caused the exception.

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

An action you attempted resulted in an exception.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.pipes#CreatePipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#CreatePipeRequest" + }, + "output": { + "target": "com.amazonaws.pipes#CreatePipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#ConflictException" + }, + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pipes#ThrottlingException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a pipe", + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/pipes/{Name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pipes#CreatePipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

The name of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.pipes#PipeDescription", + "traits": { + "smithy.api#documentation": "

A description of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "Source": { + "target": "com.amazonaws.pipes#ArnOrUrl", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The ARN of the source resource.

", + "smithy.api#required": {} + } + }, + "SourceParameters": { + "target": "com.amazonaws.pipes#PipeSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up a source for your pipe.

" + } + }, + "Enrichment": { + "target": "com.amazonaws.pipes#OptionalArn", + "traits": { + "smithy.api#documentation": "

The ARN of the enrichment resource.

" + } + }, + "EnrichmentParameters": { + "target": "com.amazonaws.pipes#PipeEnrichmentParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up enrichment on your pipe.

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

The ARN of the target resource.

", + "smithy.api#required": {} + } + }, + "TargetParameters": { + "target": "com.amazonaws.pipes#PipeTargetParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

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

The ARN of the role that allows the pipe to send data to the target.

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

The list of key-value pairs to associate with the pipe.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pipes#CreatePipeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

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

The name of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

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

The time the pipe was created.

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

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pipes#Database": { + "type": "string", + "traits": { + "smithy.api#documentation": "// Redshift Database", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#DbUser": { + "type": "string", + "traits": { + "smithy.api#documentation": "// Database user name", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#DeadLetterConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pipes#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.

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

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

" + } + }, + "com.amazonaws.pipes#DeletePipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#DeletePipeRequest" + }, + "output": { + "target": "com.amazonaws.pipes#DeletePipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#ConflictException" + }, + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ThrottlingException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a pipe", + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/pipes/{Name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pipes#DeletePipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

The name of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pipes#DeletePipeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

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

The name of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeStateDescribeResponse", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

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

The time the pipe was created.

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

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pipes#DescribePipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#DescribePipeRequest" + }, + "output": { + "target": "com.amazonaws.pipes#DescribePipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ThrottlingException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to describe a pipe", + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/pipes/{Name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pipes#DescribePipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

The name of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pipes#DescribePipeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

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

The name of the pipe.

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

A description of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeStateDescribeResponse", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

" + } + }, + "StateReason": { + "target": "com.amazonaws.pipes#PipeStateReason", + "traits": { + "smithy.api#documentation": "

The reason the pipe is in its current state.

" + } + }, + "Source": { + "target": "com.amazonaws.pipes#ArnOrUrl", + "traits": { + "smithy.api#documentation": "

The ARN of the source resource.

" + } + }, + "SourceParameters": { + "target": "com.amazonaws.pipes#PipeSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up a source for your pipe.

" + } + }, + "Enrichment": { + "target": "com.amazonaws.pipes#OptionalArn", + "traits": { + "smithy.api#documentation": "

The ARN of the enrichment resource.

" + } + }, + "EnrichmentParameters": { + "target": "com.amazonaws.pipes#PipeEnrichmentParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up enrichment on your pipe.

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

The ARN of the target resource.

" + } + }, + "TargetParameters": { + "target": "com.amazonaws.pipes#PipeTargetParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

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

The ARN of the role that allows the pipe to send data to the target.

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

The list of key-value pairs to associate with the pipe.

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

The time the pipe was created.

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

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pipes#DynamoDBStreamStartPosition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRIM_HORIZON", + "name": "TRIM_HORIZON" + }, + { + "value": "LATEST", + "name": "LATEST" + } + ] + } + }, + "com.amazonaws.pipes#EcsContainerOverride": { + "type": "structure", + "members": { + "Command": { + "target": "com.amazonaws.pipes#StringList", + "traits": { + "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

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

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

" + } + }, + "Environment": { + "target": "com.amazonaws.pipes#EcsEnvironmentVariableList", + "traits": { + "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can \n override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

" + } + }, + "EnvironmentFiles": { + "target": "com.amazonaws.pipes#EcsEnvironmentFileList", + "traits": { + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

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

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. \n If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

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

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. \n You must also specify a container name.

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

The name of the container that receives the override. This parameter is required if any override is specified.

" + } + }, + "ResourceRequirements": { + "target": "com.amazonaws.pipes#EcsResourceRequirementsList", + "traits": { + "smithy.api#documentation": "

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

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

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty \n container override is {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.

" + } + }, + "com.amazonaws.pipes#EcsContainerOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#EcsContainerOverride" + } + }, + "com.amazonaws.pipes#EcsEnvironmentFile": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.pipes#EcsEnvironmentFileType", + "traits": { + "smithy.api#documentation": "

The file type to use. The only supported value is s3.

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

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

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

A list of files containing the environment variables to pass to a container. You can\n specify up to ten environment files. The file must have a .env file\n extension. Each line in an environment file should contain an environment variable in\n VARIABLE=VALUE format. Lines beginning with # are treated\n as comments and are ignored. For more information about the environment variable file\n syntax, see Declare default\n environment variables in file.

\n

If there are environment variables specified using the environment\n parameter in a container definition, they take precedence over the variables contained\n within an environment file. If multiple environment files are specified that contain the\n same variable, they're processed from the top down. We recommend that you use unique\n variable names. For more information, see Specifying environment\n variables in the Amazon Elastic Container Service Developer Guide.

\n

This parameter is only supported for tasks hosted on Fargate using the\n following platform versions:

\n " + } + }, + "com.amazonaws.pipes#EcsEnvironmentFileList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#EcsEnvironmentFile" + } + }, + "com.amazonaws.pipes#EcsEnvironmentFileType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "s3", + "name": "s3" + } + ] + } + }, + "com.amazonaws.pipes#EcsEnvironmentVariable": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the environment variable.

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

The value of the key-value pair. For environment variables, this is the value of the environment variable.

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

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can \n override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

" + } + }, + "com.amazonaws.pipes#EcsEnvironmentVariableList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#EcsEnvironmentVariable" + } + }, + "com.amazonaws.pipes#EcsEphemeralStorage": { + "type": "structure", + "members": { + "sizeInGiB": { + "target": "com.amazonaws.pipes#EphemeralStorageSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n supported value is 21 GiB and the maximum supported value is\n 200 GiB.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n expand the total amount of ephemeral storage available, beyond the default amount, for\n tasks hosted on Fargate. For more information, see Fargate task\n storage in the Amazon ECS User Guide for Fargate.

\n \n

This parameter is only supported for tasks hosted on Fargate using\n Linux platform version 1.4.0 or later. This parameter is not supported\n for Windows containers on Fargate.

\n " + } + }, + "com.amazonaws.pipes#EcsInferenceAcceleratorOverride": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

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

The Elastic Inference accelerator type to use.

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

Details on an Elastic Inference accelerator task override. This parameter is used to\n override the Elastic Inference accelerator specified in the task definition. For more\n information, see Working with Amazon\n Elastic Inference on Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.

" + } + }, + "com.amazonaws.pipes#EcsInferenceAcceleratorOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#EcsInferenceAcceleratorOverride" + } + }, + "com.amazonaws.pipes#EcsResourceRequirement": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.pipes#EcsResourceRequirementType", + "traits": { + "smithy.api#documentation": "

The type of resource to assign to a container. The supported values are\n GPU or InferenceAccelerator.

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

The value for the specified resource type.

\n

If the GPU type is used, the value is the number of physical\n GPUs the Amazon ECS container agent reserves for the container. The number\n of GPUs that's reserved for all containers in a task can't exceed the number of\n available GPUs on the container instance that the task is launched on.

\n

If the InferenceAccelerator type is used, the value matches\n the deviceName for an InferenceAccelerator specified in a\n task definition.

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

The type and amount of a resource to assign to a container. The supported resource\n types are GPUs and Elastic Inference accelerators. For more information, see Working with\n GPUs on Amazon ECS or Working with\n Amazon Elastic Inference on Amazon ECS in the\n Amazon Elastic Container Service Developer Guide\n

" + } + }, + "com.amazonaws.pipes#EcsResourceRequirementType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GPU", + "name": "GPU" + }, + { + "value": "InferenceAccelerator", + "name": "InferenceAccelerator" + } + ] + } + }, + "com.amazonaws.pipes#EcsResourceRequirementsList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#EcsResourceRequirement" + } + }, + "com.amazonaws.pipes#EcsTaskOverride": { + "type": "structure", + "members": { + "ContainerOverrides": { + "target": "com.amazonaws.pipes#EcsContainerOverrideList", + "traits": { + "smithy.api#documentation": "

One or more container overrides that are sent to a task.

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

The cpu override for the task.

" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.pipes#EcsEphemeralStorage", + "traits": { + "smithy.api#documentation": "

The ephemeral storage setting override for the task.

\n \n

This parameter is only supported for tasks hosted on Fargate that\n use the following platform versions:

\n \n " + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.pipes#ArnOrJsonPath", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more\n information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "InferenceAcceleratorOverrides": { + "target": "com.amazonaws.pipes#EcsInferenceAcceleratorOverrideList", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerator override for the task.

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

The memory override for the task.

" + } + }, + "TaskRoleArn": { + "target": "com.amazonaws.pipes#ArnOrJsonPath", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n in this task are granted the permissions that are specified in this role. For more\n information, see IAM Role for Tasks\n in the Amazon Elastic Container Service Developer Guide.

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

The overrides that are associated with a task.

" + } + }, + "com.amazonaws.pipes#EndpointString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#EphemeralStorageSize": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 21, + "max": 200 + } + } + }, + "com.amazonaws.pipes#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.pipes#EventBridgeDetailType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#EventBridgeEndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#EventBridgeEventResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#ArnOrJsonPath" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.pipes#EventBridgeEventSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#EventPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#Filter": { + "type": "structure", + "members": { + "Pattern": { + "target": "com.amazonaws.pipes#EventPattern", + "traits": { + "smithy.api#documentation": "

The event pattern.

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

Filter events using an event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + } + }, + "com.amazonaws.pipes#FilterCriteria": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.pipes#FilterList", + "traits": { + "smithy.api#documentation": "

The event patterns.

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

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + } + }, + "com.amazonaws.pipes#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.pipes#HeaderKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.pipes#HeaderParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.pipes#HeaderKey" + }, + "value": { + "target": "com.amazonaws.pipes#HeaderValue" + } + }, + "com.amazonaws.pipes#HeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#InputTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#InternalException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before retrying the action that caused the exception.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

This exception occurs due to unexpected causes.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.pipes#JsonPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*$" + } + }, + "com.amazonaws.pipes#KafkaBootstrapServers": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#EndpointString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.pipes#KafkaTopicName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 249 + }, + "smithy.api#pattern": "^[^.]([a-zA-Z0-9\\-_.]+)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#KinesisPartitionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#KinesisStreamStartPosition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRIM_HORIZON", + "name": "TRIM_HORIZON" + }, + { + "value": "LATEST", + "name": "LATEST" + }, + { + "value": "AT_TIMESTAMP", + "name": "AT_TIMESTAMP" + } + ] + } + }, + "com.amazonaws.pipes#LaunchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2", + "name": "EC2" + }, + { + "value": "FARGATE", + "name": "FARGATE" + }, + { + "value": "EXTERNAL", + "name": "EXTERNAL" + } + ] + } + }, + "com.amazonaws.pipes#LimitMax10": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.pipes#LimitMax100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.pipes#LimitMax1000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.pipes#LimitMax10000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.pipes#LimitMin1": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.pipes#ListPipes": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#ListPipesRequest" + }, + "output": { + "target": "com.amazonaws.pipes#ListPipesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#ThrottlingException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list all pipes in your account", + "smithy.api#documentation": "

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/pipes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "Limit", + "outputToken": "NextToken", + "items": "Pipes" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pipes#ListPipesRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

A value that will return a subset of the pipes associated with this account. For example, \"NamePrefix\": \"ABC\" will return \n all endpoints with \"ABC\" in the name.

", + "smithy.api#httpQuery": "NamePrefix" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

", + "smithy.api#httpQuery": "DesiredState" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

", + "smithy.api#httpQuery": "CurrentState" + } + }, + "SourcePrefix": { + "target": "com.amazonaws.pipes#ResourceArn", + "traits": { + "smithy.api#documentation": "

The prefix matching the pipe source.

", + "smithy.api#httpQuery": "SourcePrefix" + } + }, + "TargetPrefix": { + "target": "com.amazonaws.pipes#ResourceArn", + "traits": { + "smithy.api#documentation": "

The prefix matching the pipe target.

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

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. \n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination \n token will return an HTTP 400 InvalidToken error.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "Limit": { + "target": "com.amazonaws.pipes#LimitMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of pipes to include in the response.

", + "smithy.api#httpQuery": "Limit" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pipes#ListPipesResponse": { + "type": "structure", + "members": { + "Pipes": { + "target": "com.amazonaws.pipes#PipeList", + "traits": { + "smithy.api#documentation": "

The pipes returned by the call.

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

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. \n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination \n token will return an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pipes#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.pipes#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list the tags for a resource", + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "smithy.api#documentation": "

Displays the tags associated with a pipe.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pipes#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe for which you want to view tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.pipes#PipeResource", + "ids": { + "Name": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.pipes#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.pipes#TagMap", + "traits": { + "smithy.api#documentation": "

The list of key-value pairs to associate with the pipe.

" + } + } + } + }, + "com.amazonaws.pipes#LogStreamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.pipes#MQBrokerAccessCredentials": { + "type": "union", + "members": { + "BasicAuth": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret.

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

The Secrets Manager secret that stores your broker credentials.

" + } + }, + "com.amazonaws.pipes#MQBrokerQueueName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#MSKAccessCredentials": { + "type": "union", + "members": { + "SaslScram512Auth": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret.

" + } + }, + "ClientCertificateTlsAuth": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret.

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

The Secrets Manager secret that stores your stream credentials.

" + } + }, + "com.amazonaws.pipes#MSKStartPosition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRIM_HORIZON", + "name": "TRIM_HORIZON" + }, + { + "value": "LATEST", + "name": "LATEST" + } + ] + } + }, + "com.amazonaws.pipes#MaximumBatchingWindowInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 300 + } + } + }, + "com.amazonaws.pipes#MaximumRecordAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 604800 + } + } + }, + "com.amazonaws.pipes#MaximumRetryAttemptsESM": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 10000 + } + } + }, + "com.amazonaws.pipes#MessageDeduplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#MessageGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#NetworkConfiguration": { + "type": "structure", + "members": { + "awsvpcConfiguration": { + "target": "com.amazonaws.pipes#AwsVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Use this structure to specify the VPC subnets and security groups for the task, and\n whether a public IP address is to be used. This structure is relevant only for ECS tasks that\n use the awsvpc network mode.

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

This structure specifies the network configuration for an Amazon ECS task.

" + } + }, + "com.amazonaws.pipes#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.pipes#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An entity that you specified does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.pipes#OnPartialBatchItemFailureStreams": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTOMATIC_BISECT", + "name": "AUTOMATIC_BISECT" + } + ] + } + }, + "com.amazonaws.pipes#OptionalArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + } + }, + "com.amazonaws.pipes#PathParameter": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(?!\\s*$).+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#PathParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#PathParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.pipes#Pipe": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

The name of the pipe.

" + } + }, + "Arn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "aws.cloudformation#cfnAdditionalIdentifier": {}, + "smithy.api#documentation": "

The ARN of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

" + } + }, + "StateReason": { + "target": "com.amazonaws.pipes#PipeStateReason", + "traits": { + "smithy.api#documentation": "

The reason the pipe is in its current state.

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

The time the pipe was created.

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

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + }, + "Source": { + "target": "com.amazonaws.pipes#ArnOrUrl", + "traits": { + "smithy.api#documentation": "

The ARN of the source resource.

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

The ARN of the target resource.

" + } + }, + "Enrichment": { + "target": "com.amazonaws.pipes#OptionalArn", + "traits": { + "smithy.api#documentation": "

The ARN of the enrichment resource.

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

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

" + } + }, + "com.amazonaws.pipes#PipeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.*)$" + } + }, + "com.amazonaws.pipes#PipeDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^.*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#PipeEnrichmentHttpParameters": { + "type": "structure", + "members": { + "PathParameterValues": { + "target": "com.amazonaws.pipes#PathParameterList", + "traits": { + "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge\n ApiDestination path wildcards (\"*\").

" + } + }, + "HeaderParameters": { + "target": "com.amazonaws.pipes#HeaderParametersMap", + "traits": { + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST API or\n EventBridge ApiDestination.

" + } + }, + "QueryStringParameters": { + "target": "com.amazonaws.pipes#QueryStringParametersMap", + "traits": { + "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API Gateway \n REST API or EventBridge ApiDestination.

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

These are custom parameter to be used when the target is an API Gateway REST APIs or\n EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection taking\n precedence.

" + } + }, + "com.amazonaws.pipes#PipeEnrichmentParameters": { + "type": "structure", + "members": { + "InputTemplate": { + "target": "com.amazonaws.pipes#InputTemplate", + "traits": { + "smithy.api#documentation": "

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is\n passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

" + } + }, + "HttpParameters": { + "target": "com.amazonaws.pipes#PipeEnrichmentHttpParameters", + "traits": { + "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or\n EventBridge ApiDestination.

\n

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can\n use this parameter to specify headers, path parameters, and query string keys/values as part\n of your target invoking request. If you're using ApiDestinations, the corresponding Connection\n can also have these values configured. In case of any conflicting keys, values from the\n Connection take precedence.

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

The parameters required to set up enrichment on your pipe.

" + } + }, + "com.amazonaws.pipes#PipeList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#Pipe" + } + }, + "com.amazonaws.pipes#PipeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.pipes#PipeResource": { + "type": "resource", + "identifiers": { + "Name": { + "target": "com.amazonaws.pipes#PipeName" + } + }, + "put": { + "target": "com.amazonaws.pipes#CreatePipe" + }, + "read": { + "target": "com.amazonaws.pipes#DescribePipe" + }, + "update": { + "target": "com.amazonaws.pipes#UpdatePipe" + }, + "delete": { + "target": "com.amazonaws.pipes#DeletePipe" + }, + "list": { + "target": "com.amazonaws.pipes#ListPipes" + }, + "operations": [ + { + "target": "com.amazonaws.pipes#StartPipe" + }, + { + "target": "com.amazonaws.pipes#StopPipe" + } + ], + "traits": { + "aws.api#arn": { + "template": "pipe/{Name}" + }, + "aws.cloudformation#cfnResource": { + "name": "Pipe" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "pipe" + }, + "smithy.api#documentation": "Represents a pipe that will connect a source to a target through an optional filtering and enrichment step" + } + }, + "com.amazonaws.pipes#PipeSourceActiveMQBrokerParameters": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.pipes#MQBrokerAccessCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

", + "smithy.api#required": {} + } + }, + "QueueName": { + "target": "com.amazonaws.pipes#MQBrokerQueueName", + "traits": { + "smithy.api#documentation": "

The name of the destination queue to consume.

", + "smithy.api#required": {} + } + }, + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

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

The parameters for using an Active MQ broker as a source.

" + } + }, + "com.amazonaws.pipes#PipeSourceDynamoDBStreamParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax1000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.pipes#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

Define the target queue to send dead-letter queue events to.

" + } + }, + "OnPartialBatchItemFailure": { + "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", + "traits": { + "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + } + }, + "ParallelizationFactor": { + "target": "com.amazonaws.pipes#LimitMax10", + "traits": { + "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" + } + }, + "StartingPosition": { + "target": "com.amazonaws.pipes#DynamoDBStreamStartPosition", + "traits": { + "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

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

The parameters for using a DynamoDB stream as a source.

" + } + }, + "com.amazonaws.pipes#PipeSourceKinesisStreamParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.pipes#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

Define the target queue to send dead-letter queue events to.

" + } + }, + "OnPartialBatchItemFailure": { + "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", + "traits": { + "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + } + }, + "ParallelizationFactor": { + "target": "com.amazonaws.pipes#LimitMax10", + "traits": { + "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" + } + }, + "StartingPosition": { + "target": "com.amazonaws.pipes#KinesisStreamStartPosition", + "traits": { + "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

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

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

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

The parameters for using a Kinesis stream as a source.

" + } + }, + "com.amazonaws.pipes#PipeSourceManagedStreamingKafkaParameters": { + "type": "structure", + "members": { + "TopicName": { + "target": "com.amazonaws.pipes#KafkaTopicName", + "traits": { + "smithy.api#documentation": "

The name of the topic that the pipe will read from.

", + "smithy.api#required": {} + } + }, + "StartingPosition": { + "target": "com.amazonaws.pipes#MSKStartPosition", + "traits": { + "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

" + } + }, + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

" + } + }, + "ConsumerGroupID": { + "target": "com.amazonaws.pipes#URI", + "traits": { + "smithy.api#documentation": "

The name of the destination queue to consume.

" + } + }, + "Credentials": { + "target": "com.amazonaws.pipes#MSKAccessCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

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

The parameters for using an MSK stream as a source.

" + } + }, + "com.amazonaws.pipes#PipeSourceParameters": { + "type": "structure", + "members": { + "FilterCriteria": { + "target": "com.amazonaws.pipes#FilterCriteria", + "traits": { + "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + } + }, + "KinesisStreamParameters": { + "target": "com.amazonaws.pipes#PipeSourceKinesisStreamParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Kinesis stream as a source.

" + } + }, + "DynamoDBStreamParameters": { + "target": "com.amazonaws.pipes#PipeSourceDynamoDBStreamParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a DynamoDB stream as a source.

" + } + }, + "SqsQueueParameters": { + "target": "com.amazonaws.pipes#PipeSourceSqsQueueParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a source.

" + } + }, + "ActiveMQBrokerParameters": { + "target": "com.amazonaws.pipes#PipeSourceActiveMQBrokerParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an Active MQ broker as a source.

" + } + }, + "RabbitMQBrokerParameters": { + "target": "com.amazonaws.pipes#PipeSourceRabbitMQBrokerParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Rabbit MQ broker as a source.

" + } + }, + "ManagedStreamingKafkaParameters": { + "target": "com.amazonaws.pipes#PipeSourceManagedStreamingKafkaParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an MSK stream as a source.

" + } + }, + "SelfManagedKafkaParameters": { + "target": "com.amazonaws.pipes#PipeSourceSelfManagedKafkaParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

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

The parameters required to set up a source for your pipe.

" + } + }, + "com.amazonaws.pipes#PipeSourceRabbitMQBrokerParameters": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.pipes#MQBrokerAccessCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

", + "smithy.api#required": {} + } + }, + "QueueName": { + "target": "com.amazonaws.pipes#MQBrokerQueueName", + "traits": { + "smithy.api#documentation": "

The name of the destination queue to consume.

", + "smithy.api#required": {} + } + }, + "VirtualHost": { + "target": "com.amazonaws.pipes#URI", + "traits": { + "smithy.api#documentation": "

The name of the virtual host associated with the source broker.

" + } + }, + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

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

The parameters for using a Rabbit MQ broker as a source.

" + } + }, + "com.amazonaws.pipes#PipeSourceSelfManagedKafkaParameters": { + "type": "structure", + "members": { + "TopicName": { + "target": "com.amazonaws.pipes#KafkaTopicName", + "traits": { + "smithy.api#documentation": "

The name of the topic that the pipe will read from.

", + "smithy.api#required": {} + } + }, + "StartingPosition": { + "target": "com.amazonaws.pipes#SelfManagedKafkaStartPosition", + "traits": { + "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

" + } + }, + "AdditionalBootstrapServers": { + "target": "com.amazonaws.pipes#KafkaBootstrapServers", + "traits": { + "smithy.api#documentation": "

An array of server URLs.

" + } + }, + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

" + } + }, + "ConsumerGroupID": { + "target": "com.amazonaws.pipes#URI", + "traits": { + "smithy.api#documentation": "

The name of the destination queue to consume.

" + } + }, + "Credentials": { + "target": "com.amazonaws.pipes#SelfManagedKafkaAccessConfigurationCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

" + } + }, + "ServerRootCaCertificate": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret used for certification.

" + } + }, + "Vpc": { + "target": "com.amazonaws.pipes#SelfManagedKafkaAccessConfigurationVpc", + "traits": { + "smithy.api#documentation": "

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

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

The parameters for using a self-managed Apache Kafka stream as a source.

" + } + }, + "com.amazonaws.pipes#PipeSourceSqsQueueParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

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

The parameters for using a Amazon SQS stream as a source.

" + } + }, + "com.amazonaws.pipes#PipeState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + }, + { + "value": "START_FAILED", + "name": "START_FAILED" + }, + { + "value": "STOP_FAILED", + "name": "STOP_FAILED" + } + ] + } + }, + "com.amazonaws.pipes#PipeStateReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.pipes#PipeTargetBatchJobParameters": { + "type": "structure", + "members": { + "JobDefinition": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. \n If name is specified without a revision then the latest active revision is used.

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

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), \n and underscores (_).

", + "smithy.api#required": {} + } + }, + "ArrayProperties": { + "target": "com.amazonaws.pipes#BatchArrayProperties", + "traits": { + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. \n If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.pipes#BatchRetryStrategy", + "traits": { + "smithy.api#documentation": "

The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

" + } + }, + "ContainerOverrides": { + "target": "com.amazonaws.pipes#BatchContainerOverrides", + "traits": { + "smithy.api#documentation": "

The overrides that are sent to a container.

" + } + }, + "DependsOn": { + "target": "com.amazonaws.pipes#BatchDependsOn", + "traits": { + "smithy.api#documentation": "

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without \n specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N \n type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each \n dependency to complete before it can begin.

" + } + }, + "Parameters": { + "target": "com.amazonaws.pipes#BatchParametersMap", + "traits": { + "smithy.api#documentation": "

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and \n value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

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

The parameters for using an Batch job as a target.

" + } + }, + "com.amazonaws.pipes#PipeTargetCloudWatchLogsParameters": { + "type": "structure", + "members": { + "LogStreamName": { + "target": "com.amazonaws.pipes#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

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

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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

The parameters for using an CloudWatch Logs log stream as a target.

" + } + }, + "com.amazonaws.pipes#PipeTargetEcsTaskParameters": { + "type": "structure", + "members": { + "TaskDefinitionArn": { + "target": "com.amazonaws.pipes#ArnOrJsonPath", + "traits": { + "smithy.api#documentation": "

The ARN of the task definition to use if the event target is an Amazon ECS task.

", + "smithy.api#required": {} + } + }, + "TaskCount": { + "target": "com.amazonaws.pipes#LimitMin1", + "traits": { + "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is 1.

" + } + }, + "LaunchType": { + "target": "com.amazonaws.pipes#LaunchType", + "traits": { + "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate with Amazon ECS\n is supported. For more information, see Fargate on Amazon ECS in\n the Amazon Elastic Container Service Developer Guide.

" + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.pipes#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Use this structure if the Amazon ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and whether\n a public IP address is to be used. This structure is required if LaunchType is\n FARGATE because the awsvpc mode is required for Fargate\n tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.

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

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

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

Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.

" + } + }, + "CapacityProviderStrategy": { + "target": "com.amazonaws.pipes#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or launchType is\n specified, the defaultCapacityProviderStrategy for the cluster is used.

" + } + }, + "EnableECSManagedTags": { + "target": "com.amazonaws.pipes#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information,\n see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "EnableExecuteCommand": { + "target": "com.amazonaws.pipes#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not to enable the execute command functionality for the containers in this\n task. If true, this enables execute command functionality on all containers in the\n task.

" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.pipes#PlacementConstraints", + "traits": { + "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n constraints per task (including constraints in the task definition and those specified at\n runtime).

" + } + }, + "PlacementStrategy": { + "target": "com.amazonaws.pipes#PlacementStrategies", + "traits": { + "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of five\n strategy rules per task.

" + } + }, + "PropagateTags": { + "target": "com.amazonaws.pipes#PropagateTags", + "traits": { + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no value\n is specified, the tags are not propagated. Tags can only be propagated to the task during task\n creation. To add tags to a task after task creation, use the TagResource API action.

" + } + }, + "ReferenceId": { + "target": "com.amazonaws.pipes#ReferenceId", + "traits": { + "smithy.api#documentation": "

The reference ID to use for the task.

" + } + }, + "Overrides": { + "target": "com.amazonaws.pipes#EcsTaskOverride", + "traits": { + "smithy.api#documentation": "

The overrides that are associated with a task.

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

The metadata that you apply to the task to help you categorize and organize them. Each tag\n consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

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

The parameters for using an Amazon ECS task as a target.

" + } + }, + "com.amazonaws.pipes#PipeTargetEventBridgeEventBusParameters": { + "type": "structure", + "members": { + "EndpointId": { + "target": "com.amazonaws.pipes#EventBridgeEndpointId", + "traits": { + "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

\n \n

When using Java, you must include auth-crt on the class path.

\n " + } + }, + "DetailType": { + "target": "com.amazonaws.pipes#EventBridgeDetailType", + "traits": { + "smithy.api#documentation": "

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

" + } + }, + "Source": { + "target": "com.amazonaws.pipes#EventBridgeEventSource", + "traits": { + "smithy.api#documentation": "

The source of the event.

" + } + }, + "Resources": { + "target": "com.amazonaws.pipes#EventBridgeEventResourceList", + "traits": { + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

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

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

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

The parameters for using an EventBridge event bus as a target.

" + } + }, + "com.amazonaws.pipes#PipeTargetHttpParameters": { + "type": "structure", + "members": { + "PathParameterValues": { + "target": "com.amazonaws.pipes#PathParameterList", + "traits": { + "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge\n ApiDestination path wildcards (\"*\").

" + } + }, + "HeaderParameters": { + "target": "com.amazonaws.pipes#HeaderParametersMap", + "traits": { + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST API or\n EventBridge ApiDestination.

" + } + }, + "QueryStringParameters": { + "target": "com.amazonaws.pipes#QueryStringParametersMap", + "traits": { + "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API Gateway \n REST API or EventBridge ApiDestination.

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

These are custom parameter to be used when the target is an API Gateway REST APIs or\n EventBridge ApiDestinations.

" + } + }, + "com.amazonaws.pipes#PipeTargetInvocationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REQUEST_RESPONSE", + "name": "REQUEST_RESPONSE" + }, + { + "value": "FIRE_AND_FORGET", + "name": "FIRE_AND_FORGET" + } + ] + } + }, + "com.amazonaws.pipes#PipeTargetKinesisStreamParameters": { + "type": "structure", + "members": { + "PartitionKey": { + "target": "com.amazonaws.pipes#KinesisPartitionKey", + "traits": { + "smithy.api#documentation": "

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters \n for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. \n Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this \n hashing mechanism, all data records with the same partition key map to the same shard within the stream.

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

The parameters for using a Kinesis stream as a source.

" + } + }, + "com.amazonaws.pipes#PipeTargetLambdaFunctionParameters": { + "type": "structure", + "members": { + "InvocationType": { + "target": "com.amazonaws.pipes#PipeTargetInvocationType", + "traits": { + "smithy.api#documentation": "

Choose from the following options.

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

The parameters for using a Lambda function as a target.

" + } + }, + "com.amazonaws.pipes#PipeTargetParameters": { + "type": "structure", + "members": { + "InputTemplate": { + "target": "com.amazonaws.pipes#InputTemplate", + "traits": { + "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

" + } + }, + "LambdaFunctionParameters": { + "target": "com.amazonaws.pipes#PipeTargetLambdaFunctionParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Lambda function as a target.

" + } + }, + "StepFunctionStateMachineParameters": { + "target": "com.amazonaws.pipes#PipeTargetStateMachineParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Step Functions state machine as a target.

" + } + }, + "KinesisStreamParameters": { + "target": "com.amazonaws.pipes#PipeTargetKinesisStreamParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Kinesis stream as a source.

" + } + }, + "EcsTaskParameters": { + "target": "com.amazonaws.pipes#PipeTargetEcsTaskParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an Amazon ECS task as a target.

" + } + }, + "BatchJobParameters": { + "target": "com.amazonaws.pipes#PipeTargetBatchJobParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an Batch job as a target.

" + } + }, + "SqsQueueParameters": { + "target": "com.amazonaws.pipes#PipeTargetSqsQueueParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a source.

" + } + }, + "HttpParameters": { + "target": "com.amazonaws.pipes#PipeTargetHttpParameters", + "traits": { + "smithy.api#documentation": "

These are custom parameter to be used when the target is an API Gateway REST APIs or\n EventBridge ApiDestinations.

" + } + }, + "RedshiftDataParameters": { + "target": "com.amazonaws.pipes#PipeTargetRedshiftDataParameters", + "traits": { + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement.

" + } + }, + "SageMakerPipelineParameters": { + "target": "com.amazonaws.pipes#PipeTargetSageMakerPipelineParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a SageMaker pipeline as a target.

" + } + }, + "EventBridgeEventBusParameters": { + "target": "com.amazonaws.pipes#PipeTargetEventBridgeEventBusParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an EventBridge event bus as a target.

" + } + }, + "CloudWatchLogsParameters": { + "target": "com.amazonaws.pipes#PipeTargetCloudWatchLogsParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an CloudWatch Logs log stream as a target.

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

The parameters required to set up a target for your pipe.

" + } + }, + "com.amazonaws.pipes#PipeTargetRedshiftDataParameters": { + "type": "structure", + "members": { + "SecretManagerArn": { + "target": "com.amazonaws.pipes#SecretManagerArnOrJsonPath", + "traits": { + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using SageMaker.

" + } + }, + "Database": { + "target": "com.amazonaws.pipes#Database", + "traits": { + "smithy.api#documentation": "

The name of the database. Required when authenticating using temporary credentials.

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

The database user name. Required when authenticating using temporary credentials.

" + } + }, + "StatementName": { + "target": "com.amazonaws.pipes#StatementName", + "traits": { + "smithy.api#documentation": "

The name of the SQL statement. You can name the SQL statement when you create it to\n identify the query.

" + } + }, + "WithEvent": { + "target": "com.amazonaws.pipes#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to send an event back to EventBridge after the SQL statement\n runs.

" + } + }, + "Sqls": { + "target": "com.amazonaws.pipes#Sqls", + "traits": { + "smithy.api#documentation": "

The SQL statement text to run.

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

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement.

" + } + }, + "com.amazonaws.pipes#PipeTargetSageMakerPipelineParameters": { + "type": "structure", + "members": { + "PipelineParameterList": { + "target": "com.amazonaws.pipes#SageMakerPipelineParameterList", + "traits": { + "smithy.api#documentation": "

List of Parameter names and values for SageMaker Model Building Pipeline execution.

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

The parameters for using a SageMaker pipeline as a target.

" + } + }, + "com.amazonaws.pipes#PipeTargetSqsQueueParameters": { + "type": "structure", + "members": { + "MessageGroupId": { + "target": "com.amazonaws.pipes#MessageGroupId", + "traits": { + "smithy.api#documentation": "

The FIFO message group ID to use as the target.

" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.pipes#MessageDeduplicationId", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of sent messages.

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

The parameters for using a Amazon SQS stream as a source.

" + } + }, + "com.amazonaws.pipes#PipeTargetStateMachineParameters": { + "type": "structure", + "members": { + "InvocationType": { + "target": "com.amazonaws.pipes#PipeTargetInvocationType", + "traits": { + "smithy.api#documentation": "

Specify whether to wait for the state machine to finish or not.

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

The parameters for using a Step Functions state machine as a target.

" + } + }, + "com.amazonaws.pipes#Pipes": { + "type": "service", + "version": "2015-10-07", + "operations": [ + { + "target": "com.amazonaws.pipes#ListTagsForResource" + }, + { + "target": "com.amazonaws.pipes#TagResource" + }, + { + "target": "com.amazonaws.pipes#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.pipes#PipeResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Pipes", + "arnNamespace": "pipes", + "cloudFormationName": "Pipes", + "cloudTrailEventSource": "pipes.amazonaws.com", + "endpointPrefix": "pipes" + }, + "aws.auth#sigv4": { + "name": "pipes" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by tag-value associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by allowed set of values for each of the tags", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the presence of mandatory tags in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + } + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "origin": "*", + "additionalAllowedHeaders": [ + "*", + "Authorization", + "Date", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "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-errormessage", + "x-amzn-trace-id", + "x-amz-apigw-id", + "date" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing \n event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. \n To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.

", + "smithy.api#title": "Amazon EventBridge Pipes", + "smithy.api#xmlNamespace": { + "uri": "http://events.amazonaws.com/doc/2015-10-07" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://pipes.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.pipes#PlacementConstraint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.pipes#PlacementConstraintType", + "traits": { + "smithy.api#documentation": "

The type of constraint. Use distinctInstance to ensure that each task in a particular\n group is running on a different container instance. Use memberOf to restrict the selection to\n a group of valid candidates.

" + } + }, + "expression": { + "target": "com.amazonaws.pipes#PlacementConstraintExpression", + "traits": { + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.\n

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

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "com.amazonaws.pipes#PlacementConstraintExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#PlacementConstraintType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "distinctInstance", + "name": "DISTINCT_INSTANCE" + }, + { + "value": "memberOf", + "name": "MEMBER_OF" + } + ] + } + }, + "com.amazonaws.pipes#PlacementConstraints": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#PlacementConstraint" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.pipes#PlacementStrategies": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#PlacementStrategy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.pipes#PlacementStrategy": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.pipes#PlacementStrategyType", + "traits": { + "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly places tasks on\n available candidates. The spread placement strategy spreads placement across available\n candidates evenly based on the field parameter. The binpack strategy places tasks on available\n candidates that have the least available amount of the resource that is specified with the\n field parameter. For example, if you binpack on memory, a task is placed on the instance with\n the least amount of remaining memory (but still enough to run the task).

" + } + }, + "field": { + "target": "com.amazonaws.pipes#PlacementStrategyField", + "traits": { + "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread placement strategy,\n valid values are instanceId (or host, which has the same effect), or any platform or custom\n attribute that is applied to a container instance, such as attribute:ecs.availability-zone.\n For the binpack placement strategy, valid values are cpu and memory. For the random placement\n strategy, this field is not used.

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

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer\n Guide.

" + } + }, + "com.amazonaws.pipes#PlacementStrategyField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#PlacementStrategyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "random", + "name": "RANDOM" + }, + { + "value": "spread", + "name": "SPREAD" + }, + { + "value": "binpack", + "name": "BINPACK" + } + ] + } + }, + "com.amazonaws.pipes#PropagateTags": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TASK_DEFINITION", + "name": "TASK_DEFINITION" + } + ] + } + }, + "com.amazonaws.pipes#QueryStringKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x1F\\x7F]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.pipes#QueryStringParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.pipes#QueryStringKey" + }, + "value": { + "target": "com.amazonaws.pipes#QueryStringValue" + } + }, + "com.amazonaws.pipes#QueryStringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#ReferenceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#RequestedPipeState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.pipes#RequestedPipeStateDescribeResponse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.pipes#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.pipes#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.pipes#SageMakerPipelineParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#SageMakerPipelineParameterName", + "traits": { + "smithy.api#documentation": "

Name of parameter to start execution of a SageMaker Model Building Pipeline.

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

Value of parameter to start execution of a SageMaker Model Building Pipeline.

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

Name/Value pair of a parameter to start execution of a SageMaker Model Building\n Pipeline.

" + } + }, + "com.amazonaws.pipes#SageMakerPipelineParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#SageMakerPipelineParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.pipes#SageMakerPipelineParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#SageMakerPipelineParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#SecretManagerArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "// Optional SecretManager ARN which stores the database credentials", + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.pipes#SecretManagerArnOrJsonPath": { + "type": "string", + "traits": { + "smithy.api#documentation": "// For targets, can either specify an ARN or a jsonpath pointing to the ARN.", + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.pipes#SecurityGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^sg-[0-9a-zA-Z]*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^sg-[0-9a-zA-Z]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#SecurityGroupId" + }, + "traits": { + "smithy.api#documentation": "List of SecurityGroupId.", + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.pipes#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#SecurityGroup" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.pipes#SelfManagedKafkaAccessConfigurationCredentials": { + "type": "union", + "members": { + "BasicAuth": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret.

" + } + }, + "SaslScram512Auth": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret.

" + } + }, + "SaslScram256Auth": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret.

" + } + }, + "ClientCertificateTlsAuth": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret.

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

The Secrets Manager secret that stores your stream credentials.

" + } + }, + "com.amazonaws.pipes#SelfManagedKafkaAccessConfigurationVpc": { + "type": "structure", + "members": { + "Subnets": { + "target": "com.amazonaws.pipes#SubnetIds", + "traits": { + "smithy.api#documentation": "

Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

" + } + }, + "SecurityGroup": { + "target": "com.amazonaws.pipes#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many \n as five security groups. If you do not specify a security group, the default security group for the VPC is used.

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

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

" + } + }, + "com.amazonaws.pipes#SelfManagedKafkaStartPosition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRIM_HORIZON", + "name": "TRIM_HORIZON" + }, + { + "value": "LATEST", + "name": "LATEST" + } + ] + } + }, + "com.amazonaws.pipes#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that caused the exception.

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

The type of resource that caused the exception.

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

The identifier of the service that caused the exception.

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

The identifier of the quota that caused the exception.

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

A quota has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.pipes#Sql": { + "type": "string", + "traits": { + "smithy.api#documentation": "// A single Redshift SQL", + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#Sqls": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#Sql" + }, + "traits": { + "smithy.api#documentation": "// A list of SQLs.", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.pipes#StartPipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#StartPipeRequest" + }, + "output": { + "target": "com.amazonaws.pipes#StartPipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#ConflictException" + }, + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ThrottlingException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a pipe", + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Start an existing pipe.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/pipes/{Name}/start", + "code": 200 + } + } + }, + "com.amazonaws.pipes#StartPipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

The name of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pipes#StartPipeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

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

The name of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

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

The time the pipe was created.

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

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pipes#StatementName": { + "type": "string", + "traits": { + "smithy.api#documentation": "// A name for Redshift DataAPI statement which can be used as filter of\n// ListStatement.", + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#StopPipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#StopPipeRequest" + }, + "output": { + "target": "com.amazonaws.pipes#StopPipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#ConflictException" + }, + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ThrottlingException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to stop a pipe", + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Stop an existing pipe.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/pipes/{Name}/stop", + "code": 200 + } + } + }, + "com.amazonaws.pipes#StopPipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

The name of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pipes#StopPipeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

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

The name of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

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

The time the pipe was created.

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

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pipes#String": { + "type": "string" + }, + "com.amazonaws.pipes#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#String" + } + }, + "com.amazonaws.pipes#Subnet": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^subnet-[0-9a-z]*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^subnet-[0-9a-z]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#SubnetId" + }, + "traits": { + "smithy.api#documentation": "List of SubnetId.", + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.pipes#Subnets": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#Subnet" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.pipes#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.pipes#TagKey", + "traits": { + "smithy.api#documentation": "

A string you can use to assign a value. The combination of tag keys and values can help\n you organize and categorize your resources.

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

The value for the specified tag key.

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

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses\n support tagging.

" + } + }, + "com.amazonaws.pipes#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.pipes#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.pipes#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#Tag" + } + }, + "com.amazonaws.pipes#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.pipes#TagKey" + }, + "value": { + "target": "com.amazonaws.pipes#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.pipes#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pipes#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to add tags to a resource", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}", + "aws:ResourceTag/${TagKey}" + ], + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified pipe. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of\n characters.

\n

You can use the TagResource action with a pipe that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n pipe. If you specify a tag key that is already associated with the pipe, the new tag\n value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a pipe.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pipes#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.pipes#TagMap", + "traits": { + "smithy.api#documentation": "

The list of key-value pairs associated with the pipe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.pipes#PipeResource", + "ids": { + "Name": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.pipes#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.pipes#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the service that caused the exception.

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

The identifier of the quota that caused the exception.

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

The number of seconds to wait before retrying the action that caused the exception.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

An action was throttled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.pipes#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.pipes#URI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.pipes#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pipes#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove the tags for a resource", + "aws.iam#conditionKeys": [ + "aws:TagKeys" + ], + "smithy.api#documentation": "

Removes one or more tags from the specified pipes.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pipes#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.pipes#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tag keys to remove from the pipe.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.pipes#PipeResource", + "ids": { + "Name": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.pipes#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.pipes#UpdatePipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.pipes#UpdatePipeRequest" + }, + "output": { + "target": "com.amazonaws.pipes#UpdatePipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pipes#ConflictException" + }, + { + "target": "com.amazonaws.pipes#InternalException" + }, + { + "target": "com.amazonaws.pipes#NotFoundException" + }, + { + "target": "com.amazonaws.pipes#ThrottlingException" + }, + { + "target": "com.amazonaws.pipes#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update a pipe", + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. \n The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or \n TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that \n if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.

\n \n

For more information about pipes, see \n Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/pipes/{Name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pipes#UpdatePipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pipes#PipeName", + "traits": { + "smithy.api#documentation": "

The name of the pipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.pipes#PipeDescription", + "traits": { + "smithy.api#documentation": "

A description of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "SourceParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceParameters", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The parameters required to set up a source for your pipe.

" + } + }, + "Enrichment": { + "target": "com.amazonaws.pipes#OptionalArn", + "traits": { + "smithy.api#documentation": "

The ARN of the enrichment resource.

" + } + }, + "EnrichmentParameters": { + "target": "com.amazonaws.pipes#PipeEnrichmentParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up enrichment on your pipe.

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

The ARN of the target resource.

" + } + }, + "TargetParameters": { + "target": "com.amazonaws.pipes#PipeTargetParameters", + "traits": { + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

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

The ARN of the role that allows the pipe to send data to the target.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pipes#UpdatePipeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pipes#PipeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the pipe.

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

The name of the pipe.

" + } + }, + "DesiredState": { + "target": "com.amazonaws.pipes#RequestedPipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe should be in.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.pipes#PipeState", + "traits": { + "smithy.api#documentation": "

The state the pipe is in.

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

The time the pipe was created.

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

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pipes#UpdatePipeSourceActiveMQBrokerParameters": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.pipes#MQBrokerAccessCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

", + "smithy.api#required": {} + } + }, + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

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

The parameters for using an Active MQ broker as a source.

" + } + }, + "com.amazonaws.pipes#UpdatePipeSourceDynamoDBStreamParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax1000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.pipes#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

Define the target queue to send dead-letter queue events to.

" + } + }, + "OnPartialBatchItemFailure": { + "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", + "traits": { + "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + } + }, + "ParallelizationFactor": { + "target": "com.amazonaws.pipes#LimitMax10", + "traits": { + "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

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

The parameters for using a DynamoDB stream as a source.

" + } + }, + "com.amazonaws.pipes#UpdatePipeSourceKinesisStreamParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.pipes#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

Define the target queue to send dead-letter queue events to.

" + } + }, + "OnPartialBatchItemFailure": { + "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", + "traits": { + "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", + "traits": { + "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + } + }, + "ParallelizationFactor": { + "target": "com.amazonaws.pipes#LimitMax10", + "traits": { + "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

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

The parameters for using a Kinesis stream as a source.

" + } + }, + "com.amazonaws.pipes#UpdatePipeSourceManagedStreamingKafkaParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "Credentials": { + "target": "com.amazonaws.pipes#MSKAccessCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

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

The parameters for using an MSK stream as a source.

" + } + }, + "com.amazonaws.pipes#UpdatePipeSourceParameters": { + "type": "structure", + "members": { + "FilterCriteria": { + "target": "com.amazonaws.pipes#FilterCriteria", + "traits": { + "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + } + }, + "KinesisStreamParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceKinesisStreamParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Kinesis stream as a source.

" + } + }, + "DynamoDBStreamParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceDynamoDBStreamParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a DynamoDB stream as a source.

" + } + }, + "SqsQueueParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceSqsQueueParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a source.

" + } + }, + "ActiveMQBrokerParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceActiveMQBrokerParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an Active MQ broker as a source.

" + } + }, + "RabbitMQBrokerParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceRabbitMQBrokerParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Rabbit MQ broker as a source.

" + } + }, + "ManagedStreamingKafkaParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceManagedStreamingKafkaParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using an MSK stream as a source.

" + } + }, + "SelfManagedKafkaParameters": { + "target": "com.amazonaws.pipes#UpdatePipeSourceSelfManagedKafkaParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

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

The parameters required to set up a source for your pipe.

" + } + }, + "com.amazonaws.pipes#UpdatePipeSourceRabbitMQBrokerParameters": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.pipes#MQBrokerAccessCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

", + "smithy.api#required": {} + } + }, + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

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

The parameters for using a Rabbit MQ broker as a source.

" + } + }, + "com.amazonaws.pipes#UpdatePipeSourceSelfManagedKafkaParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

" + } + }, + "Credentials": { + "target": "com.amazonaws.pipes#SelfManagedKafkaAccessConfigurationCredentials", + "traits": { + "smithy.api#documentation": "

The credentials needed to access the resource.

" + } + }, + "ServerRootCaCertificate": { + "target": "com.amazonaws.pipes#SecretManagerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret used for certification.

" + } + }, + "Vpc": { + "target": "com.amazonaws.pipes#SelfManagedKafkaAccessConfigurationVpc", + "traits": { + "smithy.api#documentation": "

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

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

The parameters for using a self-managed Apache Kafka stream as a source.

" + } + }, + "com.amazonaws.pipes#UpdatePipeSourceSqsQueueParameters": { + "type": "structure", + "members": { + "BatchSize": { + "target": "com.amazonaws.pipes#LimitMax10000", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in each batch.

" + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.pipes#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum length of a time to wait for events.

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

The parameters for using a Amazon SQS stream as a source.

" + } + }, + "com.amazonaws.pipes#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.pipes#ErrorMessage" + }, + "fieldList": { + "target": "com.amazonaws.pipes#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The list of fields for which validation failed and the corresponding failure messages.

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

Indicates that an error has occurred while performing a validate operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.pipes#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the exception.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.pipes#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The message of the exception.

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

Indicates that an error has occurred while performing a validate operation.

" + } + }, + "com.amazonaws.pipes#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#ValidationExceptionField" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/sfn.json b/codegen/sdk-codegen/aws-models/sfn.json index d5c4c3236ef..35c44025d76 100644 --- a/codegen/sdk-codegen/aws-models/sfn.json +++ b/codegen/sdk-codegen/aws-models/sfn.json @@ -51,6 +51,9 @@ { "target": "com.amazonaws.sfn#DescribeExecution" }, + { + "target": "com.amazonaws.sfn#DescribeMapRun" + }, { "target": "com.amazonaws.sfn#DescribeStateMachine" }, @@ -69,6 +72,9 @@ { "target": "com.amazonaws.sfn#ListExecutions" }, + { + "target": "com.amazonaws.sfn#ListMapRuns" + }, { "target": "com.amazonaws.sfn#ListStateMachines" }, @@ -99,6 +105,9 @@ { "target": "com.amazonaws.sfn#UntagResource" }, + { + "target": "com.amazonaws.sfn#UpdateMapRun" + }, { "target": "com.amazonaws.sfn#UpdateStateMachine" } @@ -125,7 +134,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -2778,10 +2787,13 @@ "errors": [ { "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Deletes a state machine. This is an asynchronous operation: It sets the state machine's\n status to DELETING and begins the deletion process.

\n \n

For EXPRESS state machines, the deletion will happen eventually (usually\n less than a minute). Running executions may emit logs after DeleteStateMachine\n API is called.

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

Deletes a state machine. This is an asynchronous operation: It sets the state machine's\n status to DELETING and begins the deletion process.

\n \n

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

For EXPRESS state machines, the deletion will happen eventually (usually\n less than a minute). Running executions may emit logs after DeleteStateMachine\n API is called.

\n " } }, "com.amazonaws.sfn#DeleteStateMachineInput": { @@ -2875,7 +2887,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes an execution.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

" + "smithy.api#documentation": "

Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machine executions unless they were dispatched by a Map Run.

" } }, "com.amazonaws.sfn#DescribeExecutionInput": { @@ -2956,6 +2968,133 @@ "traits": { "smithy.api#documentation": "

The X-Ray trace header that was passed to the execution.

" } + }, + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

" + } + }, + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

The error string if the state machine execution failed.

" + } + }, + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", + "traits": { + "smithy.api#documentation": "

The cause string if the state machine execution failed.

" + } + } + } + }, + "com.amazonaws.sfn#DescribeMapRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#DescribeMapRunInput" + }, + "output": { + "target": "com.amazonaws.sfn#DescribeMapRunOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.

" + } + }, + "com.amazonaws.sfn#DescribeMapRunInput": { + "type": "structure", + "members": { + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies a Map Run.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sfn#DescribeMapRunOutput": { + "type": "structure", + "members": { + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies a Map Run.

", + "smithy.api#required": {} + } + }, + "executionArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.sfn#MapRunStatus", + "traits": { + "smithy.api#documentation": "

The current status of the Map Run.

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

The date when the Map Run was started.

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

The date when the Map Run was stopped.

" + } + }, + "maxConcurrency": { + "target": "com.amazonaws.sfn#MaxConcurrency", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

", + "smithy.api#required": {} + } + }, + "toleratedFailurePercentage": { + "target": "com.amazonaws.sfn#ToleratedFailurePercentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum percentage of failed child workflow executions before the Map Run fails.

", + "smithy.api#required": {} + } + }, + "toleratedFailureCount": { + "target": "com.amazonaws.sfn#ToleratedFailureCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of failed child workflow executions before the Map Run fails.

", + "smithy.api#required": {} + } + }, + "itemCounts": { + "target": "com.amazonaws.sfn#MapRunItemCounts", + "traits": { + "smithy.api#documentation": "

A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

", + "smithy.api#required": {} + } + }, + "executionCounts": { + "target": "com.amazonaws.sfn#MapRunExecutionCounts", + "traits": { + "smithy.api#documentation": "

A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

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

Describes a state machine.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

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

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n " } }, "com.amazonaws.sfn#DescribeStateMachineForExecution": { @@ -2996,7 +3135,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the state machine associated with a specific execution.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

" + "smithy.api#documentation": "

Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

" } }, "com.amazonaws.sfn#DescribeStateMachineForExecutionInput": { @@ -3057,6 +3196,18 @@ "traits": { "smithy.api#documentation": "

Selects whether X-Ray tracing is enabled.

" } + }, + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

" + } + }, + "label": { + "target": "com.amazonaws.sfn#MapRunLabel", + "traits": { + "smithy.api#documentation": "

A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

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

Selects whether X-Ray tracing is enabled.

" } + }, + "label": { + "target": "com.amazonaws.sfn#MapRunLabel", + "traits": { + "smithy.api#documentation": "

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

" + } } } }, @@ -3274,6 +3431,19 @@ "traits": { "smithy.api#documentation": "

If the execution already ended, the date the execution stopped.

" } + }, + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

" + } + }, + "itemCount": { + "target": "com.amazonaws.sfn#UnsignedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

" + } } }, "traits": { @@ -3699,6 +3869,18 @@ }, "stateExitedEventDetails": { "target": "com.amazonaws.sfn#StateExitedEventDetails" + }, + "mapRunStartedEventDetails": { + "target": "com.amazonaws.sfn#MapRunStartedEventDetails", + "traits": { + "smithy.api#documentation": "

Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.

" + } + }, + "mapRunFailedEventDetails": { + "target": "com.amazonaws.sfn#MapRunFailedEventDetails", + "traits": { + "smithy.api#documentation": "

Contains error and cause details about a Map Run that failed.

" + } } }, "traits": { @@ -4061,6 +4243,30 @@ "traits": { "smithy.api#enumValue": "WaitStateExited" } + }, + "MapRunAborted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MapRunAborted" + } + }, + "MapRunFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MapRunFailed" + } + }, + "MapRunStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MapRunStarted" + } + }, + "MapRunSucceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MapRunSucceeded" + } } } }, @@ -4090,7 +4296,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided Amazon Resource Name (ARN) is invalid.

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

The provided Amazon Resource Name (ARN) is not valid.

", "smithy.api#error": "client" } }, @@ -4102,7 +4308,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided Amazon States Language definition is invalid.

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

The provided Amazon States Language definition is not valid.

", "smithy.api#error": "client" } }, @@ -4114,7 +4320,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided JSON input data is invalid.

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

The provided JSON input data is not valid.

", "smithy.api#error": "client" } }, @@ -4138,7 +4344,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided name is invalid.

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

The provided name is not valid.

", "smithy.api#error": "client" } }, @@ -4150,7 +4356,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided JSON output data is invalid.

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

The provided JSON output data is not valid.

", "smithy.api#error": "client" } }, @@ -4162,7 +4368,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided token is invalid.

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

The provided token is not valid.

", "smithy.api#error": "client" } }, @@ -4392,15 +4598,21 @@ { "target": "com.amazonaws.sfn#InvalidToken" }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + }, { "target": "com.amazonaws.sfn#StateMachineDoesNotExist" }, { "target": "com.amazonaws.sfn#StateMachineTypeNotSupported" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Lists the executions of a state machine that meet the filtering criteria. Results are\n sorted by time, with the most recent execution first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

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

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

\n

Results are\n sorted by time, with the most recent execution first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4415,8 +4627,7 @@ "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

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

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

\n

You can specify either a mapRunArn or a stateMachineArn, but not both.

" } }, "statusFilter": { @@ -4437,6 +4648,12 @@ "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } + }, + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

\n

You can specify either a mapRunArn or a stateMachineArn, but not both.

" + } } } }, @@ -4467,6 +4684,78 @@ } } }, + "com.amazonaws.sfn#ListMapRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#ListMapRunsInput" + }, + "output": { + "target": "com.amazonaws.sfn#ListMapRunsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ExecutionDoesNotExist" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#InvalidToken" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "mapRuns", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.sfn#ListMapRunsInput": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.sfn#PageSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" + } + } + } + }, + "com.amazonaws.sfn#ListMapRunsOutput": { + "type": "structure", + "members": { + "mapRuns": { + "target": "com.amazonaws.sfn#MapRunList", + "traits": { + "smithy.api#documentation": "

An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.

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

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" + } + } + } + }, "com.amazonaws.sfn#ListStateMachines": { "type": "operation", "input": { @@ -4649,7 +4938,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1600 + "max": 2000 } } }, @@ -4674,6 +4963,264 @@ "smithy.api#documentation": "

Contains details about an iteration of a Map state.

" } }, + "com.amazonaws.sfn#MapRunExecutionCounts": { + "type": "structure", + "members": { + "pending": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of child workflow executions that were started by a Map Run, but haven't started executing yet.

", + "smithy.api#required": {} + } + }, + "running": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of child workflow executions that were started by a Map Run and are currently in-progress.

", + "smithy.api#required": {} + } + }, + "succeeded": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of child workflow executions that were started by a Map Run and have completed successfully.

", + "smithy.api#required": {} + } + }, + "failed": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of child workflow executions that were started by a Map Run, but have failed.

", + "smithy.api#required": {} + } + }, + "timedOut": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of child workflow executions that were started by a Map Run and have timed out.

", + "smithy.api#required": {} + } + }, + "aborted": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed.

", + "smithy.api#required": {} + } + }, + "total": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of child workflow executions that were started by a Map Run.

", + "smithy.api#required": {} + } + }, + "resultsWritten": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

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

Contains details about all of the child workflow executions started by a Map Run.

" + } + }, + "com.amazonaws.sfn#MapRunFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

The error code of the Map Run failure.

" + } + }, + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", + "traits": { + "smithy.api#documentation": "

A more detailed explanation of the cause of the failure.

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

Contains details about a Map Run failure event that occurred during a state machine execution.

" + } + }, + "com.amazonaws.sfn#MapRunItemCounts": { + "type": "structure", + "members": { + "pending": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items to process in child workflow executions that haven't started running yet.

", + "smithy.api#required": {} + } + }, + "running": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items being processed in child workflow executions that are currently in-progress.

", + "smithy.api#required": {} + } + }, + "succeeded": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items processed in child workflow executions that have completed successfully.

", + "smithy.api#required": {} + } + }, + "failed": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items processed in child workflow executions that have failed.

", + "smithy.api#required": {} + } + }, + "timedOut": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items processed in child workflow executions that have timed out.

", + "smithy.api#required": {} + } + }, + "aborted": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.

", + "smithy.api#required": {} + } + }, + "total": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items processed in all the child workflow executions started by a Map Run.

", + "smithy.api#required": {} + } + }, + "resultsWritten": { + "target": "com.amazonaws.sfn#UnsignedLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

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

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

" + } + }, + "com.amazonaws.sfn#MapRunLabel": { + "type": "string" + }, + "com.amazonaws.sfn#MapRunList": { + "type": "list", + "member": { + "target": "com.amazonaws.sfn#MapRunListItem" + } + }, + "com.amazonaws.sfn#MapRunListItem": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The executionArn of the execution from which the Map Run was started.

", + "smithy.api#required": {} + } + }, + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Map Run.

", + "smithy.api#required": {} + } + }, + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the executed state machine.

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

The date on which the Map Run started.

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

The date on which the Map Run stopped.

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

Contains details about a specific Map Run.

" + } + }, + "com.amazonaws.sfn#MapRunStartedEventDetails": { + "type": "structure", + "members": { + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Map Run that was started.

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

Contains details about a Map Run that was started during a state machine execution.

" + } + }, + "com.amazonaws.sfn#MapRunStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "ABORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTED" + } + } + } + }, "com.amazonaws.sfn#MapStateStartedEventDetails": { "type": "structure", "members": { @@ -4689,6 +5236,15 @@ "smithy.api#documentation": "

Details about a Map state that was started.

" } }, + "com.amazonaws.sfn#MaxConcurrency": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sfn#MissingRequiredParameter": { "type": "structure", "members": { @@ -4959,10 +5515,13 @@ }, { "target": "com.amazonaws.sfn#StateMachineDoesNotExist" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Starts a state machine execution.

\n \n

\n StartExecution is idempotent for STANDARD workflows. For a\n STANDARD workflow, if StartExecution is called with the same\n name and input as a running execution, the call will succeed and return the same response as\n the original request. If the execution is closed or if the input is different, it will\n return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

\n

\n StartExecution is not idempotent for EXPRESS workflows.

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

Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

\n StartExecution is idempotent for STANDARD workflows. For a\n STANDARD workflow, if StartExecution is called with the same\n name and input as a running execution, the call will succeed and return the same response as\n the original request. If the execution is closed or if the input is different, it will\n return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

\n

\n StartExecution is not idempotent for EXPRESS workflows.

\n ", "smithy.api#idempotent": {} } }, @@ -5371,6 +5930,9 @@ }, { "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { @@ -5868,6 +6430,25 @@ "com.amazonaws.sfn#Timestamp": { "type": "timestamp" }, + "com.amazonaws.sfn#ToleratedFailureCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sfn#ToleratedFailurePercentage": { + "type": "float", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.sfn#TooManyTags": { "type": "structure", "members": { @@ -5918,6 +6499,15 @@ } } }, + "com.amazonaws.sfn#UnsignedLong": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sfn#UntagResource": { "type": "operation", "input": { @@ -5961,6 +6551,66 @@ "type": "structure", "members": {} }, + "com.amazonaws.sfn#UpdateMapRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#UpdateMapRunInput" + }, + "output": { + "target": "com.amazonaws.sfn#UpdateMapRunOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + }, + { + "target": "com.amazonaws.sfn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

" + } + }, + "com.amazonaws.sfn#UpdateMapRunInput": { + "type": "structure", + "members": { + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Map Run.

", + "smithy.api#required": {} + } + }, + "maxConcurrency": { + "target": "com.amazonaws.sfn#MaxConcurrency", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.

" + } + }, + "toleratedFailurePercentage": { + "target": "com.amazonaws.sfn#ToleratedFailurePercentage", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum percentage of failed items before the Map Run fails.

" + } + }, + "toleratedFailureCount": { + "target": "com.amazonaws.sfn#ToleratedFailureCount", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of failed items before the Map Run fails.

" + } + } + } + }, + "com.amazonaws.sfn#UpdateMapRunOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.sfn#UpdateStateMachine": { "type": "operation", "input": { @@ -5990,10 +6640,13 @@ }, { "target": "com.amazonaws.sfn#StateMachineDoesNotExist" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Updates an existing state machine by modifying its definition,\n roleArn, or loggingConfiguration. Running executions will continue\n to use the previous definition and roleArn. You must include at\n least one of definition or roleArn or you will receive a\n MissingRequiredParameter error.

\n \n

All StartExecution calls within a few seconds will use the updated\n definition and roleArn. Executions started immediately after\n calling UpdateStateMachine may use the previous state machine\n definition and roleArn.

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

Updates an existing state machine by modifying its definition,\n roleArn, or loggingConfiguration. Running executions will continue\n to use the previous definition and roleArn. You must include at\n least one of definition or roleArn or you will receive a\n MissingRequiredParameter error.

\n \n

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

All StartExecution calls within a few seconds will use the updated\n definition and roleArn. Executions started immediately after\n calling UpdateStateMachine may use the previous state machine\n definition and roleArn.

\n ", "smithy.api#idempotent": {} } }, @@ -6045,6 +6698,48 @@ } } }, + "com.amazonaws.sfn#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sfn#ErrorMessage" + }, + "reason": { + "target": "com.amazonaws.sfn#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The input does not satisfy the constraints specified by an Amazon Web Services service.

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

The input does not satisfy the constraints specified by an Amazon Web Services service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sfn#ValidationExceptionReason": { + "type": "enum", + "members": { + "API_DOES_NOT_SUPPORT_LABELED_ARNS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_DOES_NOT_SUPPORT_LABELED_ARNS" + } + }, + "MISSING_REQUIRED_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_REQUIRED_PARAMETER" + } + }, + "CANNOT_UPDATE_COMPLETED_MAP_RUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANNOT_UPDATE_COMPLETED_MAP_RUN" + } + } + } + }, "com.amazonaws.sfn#includedDetails": { "type": "boolean", "traits": {