From 49a6bb8a1f374a2816f8a3a1a2b9929d643c70d7 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Tue, 12 Nov 2024 19:26:16 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/codebuild.json | 24 +- .../sdk-codegen/aws-models/controltower.json | 85 +- codegen/sdk-codegen/aws-models/fis.json | 535 +++ codegen/sdk-codegen/aws-models/gamelift.json | 3218 +++++++++++++---- .../aws-models/payment-cryptography.json | 20 +- codegen/sdk-codegen/aws-models/rds.json | 8 +- 6 files changed, 3154 insertions(+), 736 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/codebuild.json b/codegen/sdk-codegen/aws-models/codebuild.json index ad19aa82eb5..910db18d583 100644 --- a/codegen/sdk-codegen/aws-models/codebuild.json +++ b/codegen/sdk-codegen/aws-models/codebuild.json @@ -2952,7 +2952,7 @@ "environmentType": { "target": "com.amazonaws.codebuild#EnvironmentType", "traits": { - "smithy.api#documentation": "

The environment type of the compute fleet.

\n \n

For more information, see Build environment compute types in the CodeBuild\n user guide.

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

The environment type of the compute fleet.

\n \n

For more information, see Build environment compute types in the CodeBuild\n user guide.

", "smithy.api#required": {} } }, @@ -4053,6 +4053,24 @@ "smithy.api#enumValue": "ARM_LAMBDA_CONTAINER" } }, + "LINUX_EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX_EC2" + } + }, + "ARM_EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARM_EC2" + } + }, + "WINDOWS_EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_EC2" + } + }, "MAC_ARM": { "target": "smithy.api#Unit", "traits": { @@ -4215,7 +4233,7 @@ "environmentType": { "target": "com.amazonaws.codebuild#EnvironmentType", "traits": { - "smithy.api#documentation": "

The environment type of the compute fleet.

\n \n

For more information, see Build environment compute types in the CodeBuild\n user guide.

" + "smithy.api#documentation": "

The environment type of the compute fleet.

\n \n

For more information, see Build environment compute types in the CodeBuild\n user guide.

" } }, "computeType": { @@ -8820,7 +8838,7 @@ "environmentType": { "target": "com.amazonaws.codebuild#EnvironmentType", "traits": { - "smithy.api#documentation": "

The environment type of the compute fleet.

\n \n

For more information, see Build environment compute types in the CodeBuild\n user guide.

" + "smithy.api#documentation": "

The environment type of the compute fleet.

\n \n

For more information, see Build environment compute types in the CodeBuild\n user guide.

" } }, "computeType": { diff --git a/codegen/sdk-codegen/aws-models/controltower.json b/codegen/sdk-codegen/aws-models/controltower.json index b70920fe1fb..5a003e8f678 100644 --- a/codegen/sdk-codegen/aws-models/controltower.json +++ b/codegen/sdk-codegen/aws-models/controltower.json @@ -1390,6 +1390,12 @@ "traits": { "smithy.api#enumValue": "UPDATE_ENABLED_CONTROL" } + }, + "RESET_ENABLED_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET_ENABLED_CONTROL" + } } } }, @@ -2357,7 +2363,12 @@ }, "list": { "target": "com.amazonaws.controltower#ListEnabledControls" - } + }, + "operations": [ + { + "target": "com.amazonaws.controltower#ResetEnabledControl" + } + ] }, "com.amazonaws.controltower#EnabledControlSummary": { "type": "structure", @@ -4035,6 +4046,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.controltower#ResetEnabledControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#ResetEnabledControlInput" + }, + "output": { + "target": "com.amazonaws.controltower#ResetEnabledControlOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#ConflictException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Resets an enabled control.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/reset-enabled-control" + } + } + }, + "com.amazonaws.controltower#ResetEnabledControlInput": { + "type": "structure", + "members": { + "enabledControlIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the enabled control to be reset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#ResetEnabledControlOutput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The operation identifier for this ResetEnabledControl operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#ResetLandingZone": { "type": "operation", "input": { @@ -4502,7 +4583,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Updates the configuration of an already enabled control.

\n

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

\n

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.

\n

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the \n Controls Reference Guide\n .\n

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

\n Updates the configuration of an already enabled control.

\n

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

\n

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.

\n

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling the ResetEnabledControl API. Alternatively, you can call DisableControl and then call EnableControl again. Also, you can run an extending governance operation to repair drift. For usage examples, see the \n Controls Reference Guide\n .\n

", "smithy.api#http": { "code": 200, "method": "POST", diff --git a/codegen/sdk-codegen/aws-models/fis.json b/codegen/sdk-codegen/aws-models/fis.json index ec0e5a5c1f9..063d8ee7960 100644 --- a/codegen/sdk-codegen/aws-models/fis.json +++ b/codegen/sdk-codegen/aws-models/fis.json @@ -423,6 +423,38 @@ "smithy.api#documentation": "

Specifies the configuration for experiment logging.

" } }, + "com.amazonaws.fis#CreateExperimentTemplateReportConfigurationInput": { + "type": "structure", + "members": { + "outputs": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationOutputsInput", + "traits": { + "smithy.api#documentation": "

The output destinations of the experiment report.

" + } + }, + "dataSources": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationDataSourcesInput", + "traits": { + "smithy.api#documentation": "

The data sources for the experiment report.

" + } + }, + "preExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration before the experiment start time for the data sources to include in the report.

" + } + }, + "postExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration after the experiment end time for the data sources to include in the report.

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

Specifies the configuration for experiment reports.

" + } + }, "com.amazonaws.fis#CreateExperimentTemplateRequest": { "type": "structure", "members": { @@ -485,6 +517,12 @@ "traits": { "smithy.api#documentation": "

The experiment options for the experiment template.

" } + }, + "experimentReportConfiguration": { + "target": "com.amazonaws.fis#CreateExperimentTemplateReportConfigurationInput", + "traits": { + "smithy.api#documentation": "

The experiment report configuration for the experiment template.

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

The count of target account configurations for the experiment.

" } + }, + "experimentReportConfiguration": { + "target": "com.amazonaws.fis#ExperimentReportConfiguration", + "traits": { + "smithy.api#documentation": "

The experiment report configuration for the experiment.

" + } + }, + "experimentReport": { + "target": "com.amazonaws.fis#ExperimentReport", + "traits": { + "smithy.api#documentation": "

The experiment report for the experiment.

" + } } }, "traits": { @@ -1287,6 +1337,259 @@ "smithy.api#documentation": "

Describes the options for an experiment.

" } }, + "com.amazonaws.fis#ExperimentReport": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.fis#ExperimentReportState", + "traits": { + "smithy.api#documentation": "

The state of the experiment report.

" + } + }, + "s3Reports": { + "target": "com.amazonaws.fis#ExperimentReportS3ReportList", + "traits": { + "smithy.api#documentation": "

The S3 destination of the experiment report.

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

Describes the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentReportConfiguration": { + "type": "structure", + "members": { + "outputs": { + "target": "com.amazonaws.fis#ExperimentReportConfigurationOutputs", + "traits": { + "smithy.api#documentation": "

The output destinations of the experiment report.

" + } + }, + "dataSources": { + "target": "com.amazonaws.fis#ExperimentReportConfigurationDataSources", + "traits": { + "smithy.api#documentation": "

The data sources for the experiment report.

" + } + }, + "preExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration before the experiment start time for the data sources to include in the report.

" + } + }, + "postExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration after the experiment end time for the data sources to include in the report.

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

Describes the report configuration for the experiment. For more information, see Experiment report configurations for AWS FIS.

" + } + }, + "com.amazonaws.fis#ExperimentReportConfigurationCloudWatchDashboard": { + "type": "structure", + "members": { + "dashboardIdentifier": { + "target": "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.

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

Specifies the CloudWatch dashboard to include in the experiment report. The dashboard widgets will be captured as snapshot graphs within the report.

" + } + }, + "com.amazonaws.fis#ExperimentReportConfigurationCloudWatchDashboardList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentReportConfigurationCloudWatchDashboard" + } + }, + "com.amazonaws.fis#ExperimentReportConfigurationDataSources": { + "type": "structure", + "members": { + "cloudWatchDashboards": { + "target": "com.amazonaws.fis#ExperimentReportConfigurationCloudWatchDashboardList", + "traits": { + "smithy.api#documentation": "

The CloudWatch dashboards to include as data sources in the experiment report.

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

Describes the data sources for the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentReportConfigurationOutputs": { + "type": "structure", + "members": { + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentReportConfigurationOutputsS3Configuration", + "traits": { + "smithy.api#documentation": "

The S3 destination for the experiment report.

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

Describes the output destinations of the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentReportConfigurationOutputsS3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket where the experiment report will be stored.

" + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The prefix of the S3 bucket where the experiment report will be stored.

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

Specifies the S3 destination for the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentReportError": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.fis#ExperimentReportErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for the failed experiment report generation.

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

Describes the error when experiment report generation has failed.

" + } + }, + "com.amazonaws.fis#ExperimentReportErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentReportReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentReportS3Report": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.fis#ExperimentReportS3ReportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated report.

" + } + }, + "reportType": { + "target": "com.amazonaws.fis#ExperimentReportS3ReportType", + "traits": { + "smithy.api#documentation": "

The report type for the experiment report.

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

Describes the S3 destination for the report.

" + } + }, + "com.amazonaws.fis#ExperimentReportS3ReportArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentReportS3ReportList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentReportS3Report" + } + }, + "com.amazonaws.fis#ExperimentReportS3ReportType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentReportState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.fis#ExperimentReportStatus", + "traits": { + "smithy.api#documentation": "

The state of the experiment report generation.

" + } + }, + "reason": { + "target": "com.amazonaws.fis#ExperimentReportReason", + "traits": { + "smithy.api#documentation": "

The reason for the state of the experiment report generation.

" + } + }, + "error": { + "target": "com.amazonaws.fis#ExperimentReportError", + "traits": { + "smithy.api#documentation": "

The error information of the experiment when the experiment report generation has failed.

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

Describes the state of the experiment report generation.

" + } + }, + "com.amazonaws.fis#ExperimentReportStatus": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, "com.amazonaws.fis#ExperimentS3LogConfiguration": { "type": "structure", "members": { @@ -1772,6 +2075,12 @@ "traits": { "smithy.api#documentation": "

The count of target account configurations for the experiment template.

" } + }, + "experimentReportConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the report configuration for the experiment template.

" + } } }, "traits": { @@ -2004,6 +2313,114 @@ "smithy.api#documentation": "

Describes the configuration for experiment logging.

" } }, + "com.amazonaws.fis#ExperimentTemplateReportConfiguration": { + "type": "structure", + "members": { + "outputs": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationOutputs", + "traits": { + "smithy.api#documentation": "

Describes the output destinations of the experiment report.

" + } + }, + "dataSources": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationDataSources", + "traits": { + "smithy.api#documentation": "

The data sources for the experiment report.

" + } + }, + "preExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration before the experiment start time for the data sources to include in the report.

" + } + }, + "postExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration after the experiment end time for the data sources to include in the report.

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

Describes the experiment report configuration. For more information, see Experiment report configurations for AWS FIS.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateReportConfigurationCloudWatchDashboard": { + "type": "structure", + "members": { + "dashboardIdentifier": { + "target": "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.

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

The CloudWatch dashboards to include as data sources in the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateReportConfigurationCloudWatchDashboardList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationCloudWatchDashboard" + } + }, + "com.amazonaws.fis#ExperimentTemplateReportConfigurationDataSources": { + "type": "structure", + "members": { + "cloudWatchDashboards": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationCloudWatchDashboardList", + "traits": { + "smithy.api#documentation": "

The CloudWatch dashboards to include as data sources in the experiment report.

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

Describes the data sources for the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateReportConfigurationDataSourcesInput": { + "type": "structure", + "members": { + "cloudWatchDashboards": { + "target": "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardInputList", + "traits": { + "smithy.api#documentation": "

The CloudWatch dashboards to include as data sources in the experiment report.

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

Specifies the data sources for the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateReportConfigurationOutputs": { + "type": "structure", + "members": { + "s3Configuration": { + "target": "com.amazonaws.fis#ReportConfigurationS3Output", + "traits": { + "smithy.api#documentation": "

The S3 destination for the experiment report.

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

The output destinations of the experiment report.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateReportConfigurationOutputsInput": { + "type": "structure", + "members": { + "s3Configuration": { + "target": "com.amazonaws.fis#ReportConfigurationS3OutputInput", + "traits": { + "smithy.api#documentation": "

The S3 destination for the experiment report.

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

Specifies the outputs for the experiment templates.

" + } + }, "com.amazonaws.fis#ExperimentTemplateS3LogConfiguration": { "type": "structure", "members": { @@ -4114,6 +4531,86 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardInput": { + "type": "structure", + "members": { + "dashboardIdentifier": { + "target": "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.

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

Specifies the CloudWatch dashboard for the experiment report.

" + } + }, + "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ReportConfigurationCloudWatchDashboardInput" + } + }, + "com.amazonaws.fis#ReportConfigurationDuration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ReportConfigurationS3Output": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket where the experiment report will be stored.

" + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The prefix of the S3 bucket where the experiment report will be stored.

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

Describes the S3 destination for the experiment report.

" + } + }, + "com.amazonaws.fis#ReportConfigurationS3OutputInput": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket where the experiment report will be stored.

" + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The prefix of the S3 bucket where the experiment report will be stored.

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

Specifies the S3 destination for the experiment report.

" + } + }, "com.amazonaws.fis#ResolvedTarget": { "type": "structure", "members": { @@ -5003,6 +5500,38 @@ "smithy.api#documentation": "

Specifies the configuration for experiment logging.

" } }, + "com.amazonaws.fis#UpdateExperimentTemplateReportConfigurationInput": { + "type": "structure", + "members": { + "outputs": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationOutputsInput", + "traits": { + "smithy.api#documentation": "

Describes the output destinations of the experiment report.

" + } + }, + "dataSources": { + "target": "com.amazonaws.fis#ExperimentTemplateReportConfigurationDataSourcesInput", + "traits": { + "smithy.api#documentation": "

The data sources for the experiment report.

" + } + }, + "preExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration before the experiment start time for the data sources to include in the report.

" + } + }, + "postExperimentDuration": { + "target": "com.amazonaws.fis#ReportConfigurationDuration", + "traits": { + "smithy.api#documentation": "

The duration after the experiment end time for the data sources to include in the report.

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

\n Specifies the input for the experiment report configuration.

" + } + }, "com.amazonaws.fis#UpdateExperimentTemplateRequest": { "type": "structure", "members": { @@ -5055,6 +5584,12 @@ "traits": { "smithy.api#documentation": "

The experiment options for the experiment template.

" } + }, + "experimentReportConfiguration": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateReportConfigurationInput", + "traits": { + "smithy.api#documentation": "

The experiment report configuration for the experiment template.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/gamelift.json b/codegen/sdk-codegen/aws-models/gamelift.json index a2478792d04..6f776de74c8 100644 --- a/codegen/sdk-codegen/aws-models/gamelift.json +++ b/codegen/sdk-codegen/aws-models/gamelift.json @@ -215,7 +215,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 256 + "max": 512 }, "smithy.api#pattern": "^[a-zA-Z0-9:/-]+$" } @@ -344,19 +344,19 @@ "BuildArn": { "target": "com.amazonaws.gamelift#BuildArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to a Amazon 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) that is assigned to a Amazon 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 associated with a build. Build names don't need to be unique. It can be set using CreateBuild or\n UpdateBuild.

" + "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\n UpdateBuild.

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

Version information associated with a build or script. Version strings don't need to be unique.

" + "smithy.api#documentation": "

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

" } }, "Status": { @@ -448,13 +448,13 @@ "target": "com.amazonaws.gamelift#CertificateType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether a TLS/SSL certificate is generated for a fleet.

\n

Valid values include:

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

Indicates whether a TLS/SSL certificate is generated for a fleet.

\n

Valid values include:

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

\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

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 Amazon GameLift Server\n SDK operation GetInstanceCertificate.

" + "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 Amazon GameLift Server\n SDK operation GetInstanceCertificate.

" } }, "com.amazonaws.gamelift#CertificateType": { @@ -681,18 +681,24 @@ "InstanceId": { "target": "com.amazonaws.gamelift#InstanceId", "traits": { - "smithy.api#documentation": "

\n The InstanceID of the Instance hosting the compute for Container and Managed EC2 fleets.\n

" + "smithy.api#documentation": "

\n The InstanceID of the EC2 instance that is hosting the compute.\n

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

\n Some attributes of a container.\n

" + "smithy.api#documentation": "

A set of attributes for each container in the compute.

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

The game server container group definition for the compute.

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

\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

An Amazon GameLift compute resource for hosting your game servers. Computes in an Amazon GameLift\n fleet differs depending on the fleet's compute type property as follows:

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

An Amazon GameLift compute resource for hosting your game servers. Computes in an Amazon GameLift\n fleet differs depending on the fleet's compute type property as follows:

\n " } }, "com.amazonaws.gamelift#ComputeArn": { @@ -761,6 +767,12 @@ "traits": { "smithy.api#enumValue": "TERMINATING" } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } } } }, @@ -778,12 +790,6 @@ "traits": { "smithy.api#enumValue": "ANYWHERE" } - }, - "CONTAINER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINER" - } } } }, @@ -820,222 +826,33 @@ } }, "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

The set of port numbers to open on each instance in a container fleet. Connection\n ports are used by inbound traffic to connect with processes that are running in\n containers on the fleet.

\n

\n Part of:\n ContainerGroupsConfiguration, ContainerGroupsAttributes\n

" - } - }, - "com.amazonaws.gamelift#ContainerAttributes": { - "type": "structure", - "members": { - "ContainerPortMappings": { - "target": "com.amazonaws.gamelift#ContainerPortMappingList", - "traits": { - "smithy.api#documentation": "

\n Describes how container ports map to connection ports on the fleet instance.\n Incoming traffic connects to a game via a connection port.\n A ContainerPortMapping directs the traffic from a connection port to a port on the container that hosts the game session.\n

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Describes attributes of containers that are deployed to a fleet with compute type\n CONTAINER.

" - } - }, - "com.amazonaws.gamelift#ContainerCommandStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.gamelift#ContainerCpu": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10240 - } - } - }, - "com.amazonaws.gamelift#ContainerDefinition": { - "type": "structure", - "members": { - "ContainerName": { - "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The container definition identifier. Container names are unique within a container group\n definition.

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

The URI to the image that $short; copied and deployed to a container fleet. For a more\n specific identifier, see ResolvedImageDigest.

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

A unique and immutable identifier for the container image that is deployed to a container\n fleet. The digest is a SHA 256 hash of the container image manifest.

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

The amount of memory that Amazon GameLift makes available to the container. If memory limits\n aren't set for an individual container, the container shares the container group's total\n memory allocation.

\n

\n Related data type: \n ContainerGroupDefinition$TotalMemoryLimit\n

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

Defines the ports that are available to assign to processes in the container. For\n example, a game server process requires a container port to allow game clients to connect to\n it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container\n ports to externally accessible connection ports, which are assigned as needed from the\n container fleet's ConnectionPortRange.

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

The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals\n 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the\n container group.

\n

\n Related data type: \n ContainerGroupDefinition$TotalCpuLimit\n

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

A configuration for a non-terminal health check. A container, which automatically restarts\n if it stops functioning, also restarts if it fails this health check. If an essential\n container in the daemon group fails a health check, the entire container group is restarted.\n The essential container in the replica group doesn't use this health check mechanism, because\n the Amazon GameLift Agent automatically handles the task.

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

A command that's passed to the container on startup. Each argument for the command is an\n additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API\n reference.\n

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

Indicates whether the container is vital to the container group. If an essential\n container fails, the entire container group is restarted.

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

The entry point that's passed to the container on startup. If there are multiple\n arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API\n Reference.

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

The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API\n Reference.

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

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.

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

Indicates that the container relies on the status of other containers in the same\n container group during its startup and shutdown sequences. A container might have dependencies\n on multiple containers.

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Describes a container in a container fleet, the resources available to the container,\n and the commands that are run when the container starts. Container properties can't be\n updated. To change a property, create a new container group definition. See also \n ContainerDefinitionInput.

\n

\n Part of:\n ContainerGroupDefinition\n

\n

\n Returned by:\n DescribeContainerGroupDefinition, ListContainerGroupDefinitions\n

" + "smithy.api#documentation": "

The set of port numbers to open on each instance in a container fleet. Connection\n ports are used by inbound traffic to connect with processes that are running in\n containers on the fleet.

" } }, - "com.amazonaws.gamelift#ContainerDefinitionInput": { + "com.amazonaws.gamelift#ContainerAttribute": { "type": "structure", "members": { "ContainerName": { "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A string that uniquely identifies the container definition within a container\n group.

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

The location of a container image that $short; will copy and deploy to a container fleet.\n Images in Amazon Elastic Container Registry private repositories are supported. The repository must be in the same\n Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For\n limits on image size, see Amazon GameLift endpoints and quotas. You can use any of the following image URI formats:

\n ", - "smithy.api#required": {} - } - }, - "MemoryLimits": { - "target": "com.amazonaws.gamelift#ContainerMemoryLimits", - "traits": { - "smithy.api#documentation": "

The amount of memory to make available to the container. If you don't specify memory\n limits for this container, then it shares the container group's total memory allocation.

\n

\n Related data type: \n ContainerGroupDefinition$TotalMemoryLimit\n

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

A set of ports that Amazon GameLift can assign to processes in the container. All processes that\n accept inbound traffic connections, including game server processes, must be assigned a port\n from this set. The set of ports must be large enough to assign one to each process in the\n container that needs one. If the container includes your game server, include enough ports to\n assign one port to each concurrent server process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for container\n fleets.

\n

Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container\n ports to externally accessible connection ports, which are assigned as needed from the\n container fleet's ConnectionPortRange.

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

The number of CPU units to reserve for this container. The container can use more resources\n when needed, if available. Note: 1 vCPU unit equals 1024 CPU\n units. If you don't reserve CPU units for this container, then it shares the total CPU limit\n for the container group. This property is similar to the Amazon ECS container definition parameter \n environment (Amazon Elastic Container Service Developer Guide).\n

\n

\n Related data type: \n ContainerGroupDefinition$TotalCpuLimit\n

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

Configuration for a non-terminal health check. A container automatically restarts if it\n stops functioning. This parameter lets you define additional reasons to consider a container\n unhealthy and restart it. You can set a health check for any container except for the\n essential container in the replica container group. If an essential container in the daemon\n group fails a health check, the entire container group is restarted.

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

A command to pass to the container on startup. Add multiple arguments as additional\n strings in the array. See the ContainerDefinition command parameter in the Amazon Elastic Container Service API\n reference.\n

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

Specifies whether the container is vital for the container group to function properly.\n If an essential container fails, it causes the entire container group to restart. Each\n container group must have an essential container.

\n

\n Replica container groups - A replica group must have\n exactly one essential container. Use the following to configure an essential replica\n container:

\n \n

\n Daemon container groups - A daemon group must have at\n least one essential container.

\n

\n

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

An entry point to pass to the container on startup. Add multiple arguments as additional\n strings in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API\n Reference.

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

The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API\n Reference.

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

A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.

" + "smithy.api#documentation": "

The identifier for a container that's running in a compute.

" } }, - "DependsOn": { - "target": "com.amazonaws.gamelift#ContainerDependencyList", + "ContainerRuntimeId": { + "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Sets up dependencies between this container and the status of other containers in the same\n container group. A container can have dependencies on multiple different containers.

\n

You can use dependencies\n to establish a startup/shutdown sequence across the container group. A container startup\n dependency is reversed on shutdown.

\n

For example, you might specify that SideCarContainerB has a START dependency\n on SideCarContainerA. This dependency means that SideCarContainerB can't start until after\n SideCarContainerA has started. This dependency is reversed on shutdown, which means that\n SideCarContainerB must shut down before SideCarContainerA can shut down.

" + "smithy.api#documentation": "

The runtime ID for the container that's running in a compute. This value is unique within\n the compute.

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Describes a container's configuration, resources, and start instructions. Use this data\n type to create a container group definition. For the properties of a container that's been\n deployed to a fleet, see ContainerDefinition. You can't change these properties after you've created the container group definition. If you need a container group with different properties, then you must create a new one. \n

\n

\n Used with: \n CreateContainerGroupDefinition\n

" + "smithy.api#documentation": "

A unique identifier for a container in a container fleet compute.

\n

\n Returned by:\n DescribeCompute\n

" } }, - "com.amazonaws.gamelift#ContainerDefinitionInputList": { + "com.amazonaws.gamelift#ContainerAttributes": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#ContainerDefinitionInput" + "target": "com.amazonaws.gamelift#ContainerAttribute" }, "traits": { "smithy.api#length": { @@ -1044,15 +861,15 @@ } } }, - "com.amazonaws.gamelift#ContainerDefinitionList": { + "com.amazonaws.gamelift#ContainerCommandStringList": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#ContainerDefinition" + "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString" }, "traits": { "smithy.api#length": { "min": 1, - "max": 10 + "max": 20 } } }, @@ -1077,7 +894,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

A container's dependency on another container in the same container group. The dependency\n impacts how the dependent container is able to start or shut down based the status of the\n other container.

\n

For example, ContainerA is configured with the following dependency: a START\n dependency on ContainerB. This means that ContainerA can't start until ContainerB has started.\n It also means that ContainerA must shut down before ContainerB.

\n

\n Part of:\n ContainerDefinition\n

" + "smithy.api#documentation": "

A container's dependency on another container in the same container group. The dependency\n impacts how the dependent container is able to start or shut down based the status of the\n other container.

\n

For example, ContainerA is configured with the following dependency: a\n START dependency on ContainerB. This means that\n ContainerA can't start until ContainerB has\n started. It also means that ContainerA must shut down before\n ContainerB.

\n

eiifcbfhgrdurhnucnufkgbnbnnerrvbtjvljdetkehcPart of:\n GameServerContainerDefinition, GameServerContainerDefinitionInput, SupportContainerDefinition, SupportContainerDefinitionInput\n

" } }, "com.amazonaws.gamelift#ContainerDependencyCondition": { @@ -1121,18 +938,6 @@ } } }, - "com.amazonaws.gamelift#ContainerEntryPointList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, "com.amazonaws.gamelift#ContainerEnvironment": { "type": "structure", "members": { @@ -1154,7 +959,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

An environment variable to set inside a container, in the form of a key-value pair.\n

\n

\n Related data type: \n ContainerDefinition$Environment\n

" + "smithy.api#documentation": "

An environment variable to set inside a container, in the form of a key-value pair.\n

\n

\n Part of:\n GameServerContainerDefinition, GameServerContainerDefinitionInput, SupportContainerDefinition, SupportContainerDefinitionInput\n

" } }, "com.amazonaws.gamelift#ContainerEnvironmentList": { @@ -1169,245 +974,476 @@ } } }, - "com.amazonaws.gamelift#ContainerGroupDefinition": { + "com.amazonaws.gamelift#ContainerFleet": { "type": "structure", "members": { - "ContainerGroupDefinitionArn": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionArn", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies \nthe resource across all Amazon Web Services Regions. Format is \narn:aws:gamelift:::containergroupdefinition/[container group definition name].

" + "smithy.api#documentation": "

A unique identifier for the container fleet to retrieve.

" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", "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#documentation": "

The Amazon Resource Name (ARN) that is assigned to a Amazon 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.

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

The platform required for all containers in the container group definition.

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in \n the Amazon Linux 2 FAQs. \n For game servers\n that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the\n game server build to server SDK 5.x, and then deploy to AL2023 instances. See\n \n Migrate to Amazon GameLift server SDK version 5.\n

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

The unique identifier for an Identity and Access Management (IAM) role with permissions to run your\n containers on resources that are managed by Amazon GameLift. See Set up an IAM service\n role. This fleet property can't be changed.

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

A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

" + "smithy.api#documentation": "

The name of the fleet's game server container group definition, which describes how to\n deploy containers with your game server build and support software onto each fleet\n instance.

" } }, - "SchedulingStrategy": { - "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "GameServerContainerGroupDefinitionArn": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionArn", "traits": { - "smithy.api#documentation": "

The method for deploying the container group across fleet instances. A replica container\n group might have multiple copies on each fleet instance. A daemon container group maintains\n only one copy per fleet instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to the fleet's game server container group. The ARN value\n also identifies the specific container group definition version in use.

" } }, - "TotalMemoryLimit": { - "target": "com.amazonaws.gamelift#ContainerTotalMemoryLimit", + "PerInstanceContainerGroupDefinitionName": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionName", + "traits": { + "smithy.api#documentation": "

The name of the fleet's per-instance container group definition.

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

The amount of memory (in MiB) on a fleet instance to allocate for the container group. All\n containers in the group share these resources.

\n

You can set additional limits for each ContainerDefinition in\n the group. If individual containers have limits, this value must meet the following\n requirements:

\n \n

For more details on memory allocation, see the Container fleet design\n guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to the fleet's per-instance container group. The ARN value\n also identifies the specific container group definition version in use.

" } }, - "TotalCpuLimit": { - "target": "com.amazonaws.gamelift#ContainerTotalCpuLimit", + "InstanceConnectionPortRange": { + "target": "com.amazonaws.gamelift#ConnectionPortRange" + }, + "InstanceInboundPermissions": { + "target": "com.amazonaws.gamelift#IpPermissionsList", "traits": { - "smithy.api#documentation": "

The amount of CPU units on a fleet instance to allocate for the container group. All\n containers in the group share these resources. This property is an integer value in CPU units \n (1 vCPU is equal to 1024 CPU units).

\n

You can set additional limits for each ContainerDefinition in\n the group. If individual containers have limits, this value must be equal to or greater than the sum of all\n container-specific CPU limits in the group.

\n

For more details on memory allocation, see the Container fleet design\n guide.

" + "smithy.api#documentation": "

The IP address ranges and port settings that allow inbound traffic to access game\n server processes and other processes on this fleet.

" } }, - "ContainerDefinitions": { - "target": "com.amazonaws.gamelift#ContainerDefinitionList", + "GameServerContainerGroupsPerInstance": { + "target": "com.amazonaws.gamelift#GameServerContainerGroupsPerInstance", "traits": { - "smithy.api#documentation": "

\n The set of container definitions that are included in the container group.\n

" + "smithy.api#documentation": "

The number of times to replicate the game server container group on each fleet\n instance.

" } }, - "Status": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionStatus", + "MaximumGameServerContainerGroupsPerInstance": { + "target": "com.amazonaws.gamelift#MaximumGameServerContainerGroupsPerInstance", "traits": { - "smithy.api#documentation": "

Current status of the container group definition resource. Values include:

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

The calculated maximum number of game server container group that can be deployed on\n each fleet instance. The calculation depends on the resource needs of the container\n group and the CPU and memory resources of the fleet's instance type.

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

Additional information about a container group definition that's in FAILED\n status. Possible reasons include:

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

The Amazon EC2 instance type to use for all instances in the fleet. Instance type\n determines the computing resources and processing power that's available to host your\n game servers. This includes including CPU, memory, storage, and networking capacity. You\n can't update this fleet property.

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

Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn\n more about when to use On-Demand versus Spot Instances. You can't update this fleet\n property.

\n

By default, this property is set to ON_DEMAND.

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

A meaningful description of the container fleet.

" + } + }, + "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\").

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

The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups\n aggregate metrics for multiple fleets.

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

Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively\n running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down\n fleet capacity or when retiring unhealthy instances. You can also set game session\n protection for individual game sessions using UpdateGameSession.

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

A policy that limits the number of game sessions that each individual player can create\n on instances in this fleet. The limit applies for a specified span of time.

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

The current status of the container fleet.

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

Information about the most recent deployment for the container fleet.

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

The method that is used to collect container logs for the fleet. Amazon GameLift saves all\n standard output for each container in logs, including game session logs.

\n " + } + }, + "LocationAttributes": { + "target": "com.amazonaws.gamelift#ContainerFleetLocationAttributesList", + "traits": { + "smithy.api#documentation": "

Information about the container fleet's remote locations where fleet instances are\n deployed.

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

The properties that describe a container group resource. Container group definition\n properties can't be updated. To change a property, create a new container group\n definition.

\n

\n Used with:\n CreateContainerGroupDefinition\n

\n

\n Returned by:\n DescribeContainerGroupDefinition, ListContainerGroupDefinitions\n

" + "smithy.api#documentation": "

Describes an Amazon GameLift managed container fleet.

" } }, - "com.amazonaws.gamelift#ContainerGroupDefinitionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 + "com.amazonaws.gamelift#ContainerFleetBillingType": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } }, - "smithy.api#pattern": "^arn:.*:containergroupdefinition\\/containergroupdefinition-[a-zA-Z0-9-]+$" + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT" + } + } } }, - "com.amazonaws.gamelift#ContainerGroupDefinitionList": { + "com.amazonaws.gamelift#ContainerFleetList": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinition" - } - }, - "com.amazonaws.gamelift#ContainerGroupDefinitionName": { - "type": "string", + "target": "com.amazonaws.gamelift#ContainerFleet" + }, "traits": { "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + "min": 1 + } } }, - "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 + "com.amazonaws.gamelift#ContainerFleetLocationAttributes": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.gamelift#LocationStringModel", + "traits": { + "smithy.api#documentation": "

A location identifier.

" + } }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$|^arn:.*:containergroupdefinition\\/[a-zA-Z0-9\\-]+$" - } - }, - "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArnLimitedList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn" + "Status": { + "target": "com.amazonaws.gamelift#ContainerFleetLocationStatus", + "traits": { + "smithy.api#documentation": "

The status of fleet activity in the location.

\n " + } + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } + "smithy.api#documentation": "

Details about a location in a multi-location container fleet.

" } }, - "com.amazonaws.gamelift#ContainerGroupDefinitionPropertiesList": { + "com.amazonaws.gamelift#ContainerFleetLocationAttributesList": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionProperty" + "target": "com.amazonaws.gamelift#ContainerFleetLocationAttributes" } }, - "com.amazonaws.gamelift#ContainerGroupDefinitionProperty": { - "type": "structure", + "com.amazonaws.gamelift#ContainerFleetLocationStatus": { + "type": "enum", "members": { - "SchedulingStrategy": { - "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The method for scheduling and maintaining copies of the container group across a container\n fleet.

" + "smithy.api#enumValue": "PENDING" } }, - "ContainerGroupDefinitionName": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionName", + "CREATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The unique identifier for the container group definition.

" + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } } + } + }, + "com.amazonaws.gamelift#ContainerFleetRemoveAttribute": { + "type": "enum", + "members": { + "PER_INSTANCE_CONTAINER_GROUP_DEFINITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_INSTANCE_CONTAINER_GROUP_DEFINITION" + } + } + } + }, + "com.amazonaws.gamelift#ContainerFleetRemoveAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerFleetRemoveAttribute" }, "traits": { - "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

The properties of a container group that is deployed to a container fleet.

\n

\n Part of:\n ContainerGroupsAttributes\n

\n

\n Returned by:\n DescribeFleetAttributes\n

" + "smithy.api#length": { + "min": 1, + "max": 1 + } } }, - "com.amazonaws.gamelift#ContainerGroupDefinitionStatus": { + "com.amazonaws.gamelift#ContainerFleetStatus": { "type": "enum", "members": { - "READY": { + "PENDING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "READY" + "smithy.api#enumValue": "PENDING" } }, - "COPYING": { + "CREATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COPYING" + "smithy.api#enumValue": "CREATING" } }, - "FAILED": { + "CREATED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#enumValue": "CREATED" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } } } }, - "com.amazonaws.gamelift#ContainerGroupsAttributes": { + "com.amazonaws.gamelift#ContainerGroupDefinition": { "type": "structure", "members": { - "ContainerGroupDefinitionProperties": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionPropertiesList", + "ContainerGroupDefinitionArn": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionArn", "traits": { - "smithy.api#documentation": "

A collection of properties that describe each container group in the fleet. A container fleet is deployed with\n one or more ContainerGroupDefinition resources, which is where these properties are set.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies \nthe resource across all Amazon Web Services Regions. Format is \narn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version].

" } }, - "ConnectionPortRange": { - "target": "com.amazonaws.gamelift#ConnectionPortRange", + "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#ContainerOperatingSystem", + "traits": { + "smithy.api#documentation": "

The platform that all containers in the container group definition run on.

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game\n servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the game\n server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to\n Amazon GameLift server SDK version 5.\n

\n
" + } + }, + "Name": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

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

The type of container group. Container group type determines how Amazon GameLift deploys the\n container group on each fleet instance.

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

The amount of memory (in MiB) on a fleet instance to allocate for the container group. All\n containers in the group share these resources.

\n

You can set a limit for each container definition in the group. If individual containers\n have limits, this total value must be greater than any individual container's memory\n limit.

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

The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU\n is equal to 1024 CPU units). All containers in the group share these resources. You can set a\n limit for each container definition in the group. If individual containers have limits, this\n total value must be equal to or greater than the sum of the limits for each container in the\n group.

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

The definition for the game server container in this group. This property is used only\n when the container group type is GAME_SERVER. This container definition specifies\n a container image with the game server build.

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

A set of ports that allow inbound traffic to connect to processes running in the fleet's\n container groups. Amazon GameLift maps each connection port to a container port, which is assigned to\n a specific container process. A fleet's connection port range can't be changed, but you can\n control access to connection ports by updating a fleet's EC2InboundPermissions\n with UpdateFleetPortSettings.

" + "smithy.api#documentation": "

The set of definitions for support containers in this group. A container group definition\n might have zero support container definitions. Support container can be used in any type of\n container group.

" } }, - "ContainerGroupsPerInstance": { - "target": "com.amazonaws.gamelift#ContainerGroupsPerInstance", + "VersionNumber": { + "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

Details about the number of replica container groups that Amazon GameLift deploys to each instance in\n the container fleet.

" + "smithy.api#documentation": "

Indicates the version of a particular container group definition. This number is\n incremented automatically when you update a container group definition. You can view, update,\n or delete individual versions or the entire container group definition.

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

An optional description that was provided for a container group definition update. Each\n version can have a unique description.

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

Current status of the container group definition resource. Values include:

\n " + } + }, + "StatusReason": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

Additional information about a container group definition that's in FAILED\n status. Possible reasons include:

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

The properties of container groups that are running on a container fleet. Container group\n properties for a fleet can't be changed.

\n

\n Returned by:\n DescribeFleetAttributes, CreateFleet\n

" + "smithy.api#documentation": "

The properties that describe a container group resource. You can update all properties of\n a container group definition properties. Updates to a container group definition are saved as\n new versions.

\n

\n Used with:\n CreateContainerGroupDefinition\n

\n

\n Returned by:\n DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition\n

" } }, - "com.amazonaws.gamelift#ContainerGroupsConfiguration": { - "type": "structure", + "com.amazonaws.gamelift#ContainerGroupDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:.*:containergroupdefinition\\/[a-zA-Z0-9\\-]+(:[0-9]+)?$" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinition" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$|^arn:.*:containergroupdefinition\\/[a-zA-Z0-9\\-]+(:[0-9]+)?$" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionStatus": { + "type": "enum", "members": { - "ContainerGroupDefinitionNames": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArnLimitedList", + "READY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The list of container group definition names to deploy to a new container fleet.

", - "smithy.api#required": {} + "smithy.api#enumValue": "READY" } }, - "ConnectionPortRange": { - "target": "com.amazonaws.gamelift#ConnectionPortRange", + "COPYING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A set of ports to allow inbound traffic, including game clients, to connect to processes\n running in the container fleet.

\n

Connection ports are dynamically mapped to container ports, which are assigned to\n individual processes running in a container. The connection port range must have enough ports\n to map to all container ports across a fleet instance. To calculate the minimum connection\n ports needed, use the following formula:

\n

\n [Total number of container ports as defined for containers in the replica\n container group] * [Desired or calculated number of replica container groups per instance] +\n [Total number of container ports as defined for containers in the daemon container\n group]\n

\n

As a best practice, double the minimum number of connection ports.

\n \n

Use the fleet's EC2InboundPermissions property to control external access to\n connection ports. Set this property to the connection port numbers that you want to open\n access to. See IpPermission for more details.

\n
", - "smithy.api#required": {} + "smithy.api#enumValue": "COPYING" } }, - "DesiredReplicaContainerGroupsPerInstance": { - "target": "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The number of times to replicate the replica container group on each instance in a container\n fleet. By default, Amazon GameLift calculates the maximum number of replica container groups that can\n fit on a fleet instance (based on CPU and memory resources). Leave this parameter empty if you\n want to use the maximum number, or specify a desired number to override the maximum. The\n desired number is used if it's less than the maximum number.

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Configuration details for a set of container groups, for use when creating a fleet with\n compute type CONTAINER.

\n

\n Used with:\n CreateFleet\n

" } }, - "com.amazonaws.gamelift#ContainerGroupsPerInstance": { - "type": "structure", + "com.amazonaws.gamelift#ContainerGroupType": { + "type": "enum", "members": { - "DesiredReplicaContainerGroupsPerInstance": { - "target": "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance", + "GAME_SERVER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The desired number of replica container groups to place on each fleet instance.

" + "smithy.api#enumValue": "GAME_SERVER" } }, - "MaxReplicaContainerGroupsPerInstance": { - "target": "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance", + "PER_INSTANCE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The maximum possible number of replica container groups that each fleet instance can\n have.

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Determines how many replica container groups that Amazon GameLift deploys to each instance in a\n container fleet.

\n

Amazon GameLift calculates the maximum possible replica groups per instance based on the instance\n 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups\n on each fleet instance based on the following:

\n \n

\n Part of:\n ContainerGroupsConfiguration, ContainerGroupsAttributes\n

\n

\n Returned by:\n DescribeFleetAttributes, CreateFleet\n

" } }, "com.amazonaws.gamelift#ContainerHealthCheck": { @@ -1427,16 +1463,10 @@ "smithy.api#documentation": "

The time period (in seconds) between each health check.

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

The time period (in seconds) to wait for a health check to succeed before a failed health\n check is counted.

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

The number of times to retry a failed health check before the container is considered\n unhealthy. The first run of the command does not count as a retry.

" + "smithy.api#documentation": "

The number of times to retry a failed health check before flagging the container\n unhealthy. The first run of the command does not count as a retry.

" } }, "StartPeriod": { @@ -1444,10 +1474,16 @@ "traits": { "smithy.api#documentation": "

The optional grace period (in seconds) to give a container time to bootstrap before the\n first failed health check counts toward the number of retries.

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

The time period (in seconds) to wait for a health check to succeed before counting a\n failed health check.

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

Instructions on when and how to check the health of a container in a container fleet. When\n health check properties are set in a container definition, they override any Docker health\n checks in the container image. For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API.

\n

The following example instructions tell the container to wait 100 seconds after launch\n before counting failed health checks, then initiate the health check command every 60 seconds.\n After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry\n the command 3 times before considering the container to be unhealthy.

\n

\n {\"Command\": [ \"CMD-SHELL\", \"ps cax | grep \"processmanager\" || exit 1\" ], \"Interval\":\n 300, \"Timeout\": 30, \"Retries\": 5, \"StartPeriod\": 100 }\n

\n

\n Part of:\n ContainerDefinition$HealthCheck\n

" + "smithy.api#documentation": "

Instructions on when and how to check the health of a support container in a container\n fleet. These properties override any Docker health checks that are set in the container image.\n For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API. Game server\n containers don't have a health check parameter; Amazon GameLift automatically handles health checks\n for these containers.

\n

The following example instructs the container to initiate a health check command every 60\n seconds and wait 10 seconds for it to succeed. If it fails, retry the command 3 times before\n flagging the container as unhealthy. It also tells the container to wait 100 seconds after\n launch before counting failed health checks.

\n

\n {\"Command\": [ \"CMD-SHELL\", \"ps cax | grep \"processmanager\" || exit 1\" ], \"Interval\":\n 60, \"Timeout\": 10, \"Retries\": 3, \"StartPeriod\": 100 }\n

\n

\n Part of:\n SupportContainerDefinition, SupportContainerDefinitionInput\n

" } }, "com.amazonaws.gamelift#ContainerHealthCheckInterval": { @@ -1486,6 +1522,38 @@ } } }, + "com.amazonaws.gamelift#ContainerIdentifier": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#documentation": "

The identifier for a container that's running in a compute.

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

The runtime ID for the container that's running in a compute. This value is unique within\n the compute. It is returned as a ContainerAttribute value in a\n Compute object.

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

A unique identifier for a container in a compute on a managed container fleet instance.\n This information makes it possible to remotely connect to a specific container on a fleet\n instance.

\n

\n Related to:\n ContainerAttribute\n

\n

\n Use with: \n GetComputeAccess\n

" + } + }, + "com.amazonaws.gamelift#ContainerIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.gamelift#ContainerMemoryLimit": { "type": "integer", "traits": { @@ -1495,24 +1563,61 @@ } } }, - "com.amazonaws.gamelift#ContainerMemoryLimits": { + "com.amazonaws.gamelift#ContainerMountPoint": { "type": "structure", "members": { - "SoftLimit": { - "target": "com.amazonaws.gamelift#ContainerMemoryLimit", + "InstancePath": { + "target": "com.amazonaws.gamelift#InstancePathString", "traits": { - "smithy.api#documentation": "

The amount of memory that is reserved for a container. When the container group's shared\n memory is under contention, the system attempts to maintain the container memory usage at this\n soft limit. However, the container can use more memory when needed, if available. This\n property is similar to the Amazon ECS container definition parameter memoryreservation (Amazon Elastic Container Service Developer Guide).

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

The path to the source file or directory.

", + "smithy.api#required": {} } }, - "HardLimit": { - "target": "com.amazonaws.gamelift#ContainerMemoryLimit", + "ContainerPath": { + "target": "com.amazonaws.gamelift#ContainerPathString", + "traits": { + "smithy.api#documentation": "

The mount path on the container. If this property isn't set, the instance path is\n used.

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

The maximum amount of memory that the container can use. If a container attempts to exceed\n this limit, the container is stopped. This property is similar to the Amazon ECS container\n definition parameter memory in the Amazon Elastic Container Service Developer Guide.\n

" + "smithy.api#documentation": "

The type of access for the container.

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

Specifies how much memory is available to a container. You can't change this value after\n you create this object.

\n

\n Part of: \n ContainerDefinition$MemoryLimits\n

" + "smithy.api#documentation": "

A mount point that binds a container to a file or directory on the host system.

\n

\n Part of:\n GameServerContainerDefinition, GameServerContainerDefinitionInput, SupportContainerDefinition, SupportContainerDefinitionInput\n

" + } + }, + "com.amazonaws.gamelift#ContainerMountPointAccessLevel": { + "type": "enum", + "members": { + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + }, + "READ_AND_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_AND_WRITE" + } + } + } + }, + "com.amazonaws.gamelift#ContainerMountPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerMountPoint" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } } }, "com.amazonaws.gamelift#ContainerOperatingSystem": { @@ -1526,6 +1631,16 @@ } } }, + "com.amazonaws.gamelift#ContainerPathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^(\\/+[^\\/]+\\/*)+$" + } + }, "com.amazonaws.gamelift#ContainerPortConfiguration": { "type": "structure", "members": { @@ -1533,45 +1648,13 @@ "target": "com.amazonaws.gamelift#ContainerPortRangeList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Specifies one or more ranges of ports on a container.\n These ranges must not overlap.\n

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

A set of one or more container port number ranges. The ranges can't overlap.

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

Defines ranges of ports that server processes can connect to.\n

\n

\n Part of:\n ContainerDefinition$PortConfiguration\n

" - } - }, - "com.amazonaws.gamelift#ContainerPortMapping": { - "type": "structure", - "members": { - "ContainerPort": { - "target": "com.amazonaws.gamelift#PortNumber", - "traits": { - "smithy.api#documentation": "

The port opened on the container.

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

The port opened on the fleet instance. This is also called the \"host port\".

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

The network protocol that this mapping supports.

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Defines how an internal-facing container port is mapped to an external-facing connection\n port on a fleet instance of compute type CONTAINER. Incoming traffic, such as a\n game client, uses a connection port to connect to a process in the container fleet. Amazon GameLift\n directs the inbound traffic to the container port that is assigned to the process, such as a\n game session, running on a container.

\n

\n Part of:\n ContainerAttributes\n

" - } - }, - "com.amazonaws.gamelift#ContainerPortMappingList": { - "type": "list", - "member": { - "target": "com.amazonaws.gamelift#ContainerPortMapping" + "smithy.api#documentation": "

A set of port ranges that can be opened on the container. A process that's running in the\n container can bind to a port number, making it accessible to inbound traffic. Container ports\n map to a container fleet's connection ports.

\n

\n Part of:\n GameServerContainerDefinition, GameServerContainerDefinitionInput, SupportContainerDefinition, SupportContainerDefinitionInput\n

" } }, "com.amazonaws.gamelift#ContainerPortRange": { @@ -1603,7 +1686,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

A set of one or more port numbers that can be opened on the container. \n

\n

\n Part of:\n ContainerPortConfiguration\n

" + "smithy.api#documentation": "

A set of one or more port numbers that can be opened on the container. \n

\n

\n Part of:\n ContainerPortConfiguration\n

" } }, "com.amazonaws.gamelift#ContainerPortRangeList": { @@ -1618,38 +1701,30 @@ } } }, - "com.amazonaws.gamelift#ContainerSchedulingStrategy": { - "type": "enum", - "members": { - "REPLICA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICA" - } - }, - "DAEMON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAEMON" - } + "com.amazonaws.gamelift#ContainerTotalMemoryLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 4, + "max": 1024000 } } }, - "com.amazonaws.gamelift#ContainerTotalCpuLimit": { - "type": "integer", + "com.amazonaws.gamelift#ContainerTotalVcpuLimit": { + "type": "double", "traits": { "smithy.api#range": { - "min": 128, - "max": 10240 + "min": 0.125, + "max": 10 } } }, - "com.amazonaws.gamelift#ContainerTotalMemoryLimit": { - "type": "integer", + "com.amazonaws.gamelift#ContainerVcpu": { + "type": "double", "traits": { "smithy.api#range": { - "min": 4, - "max": 1024000 + "min": 0.125, + "max": 10 } } }, @@ -1753,54 +1828,215 @@ { "target": "com.amazonaws.gamelift#InvalidRequestException" }, - { - "target": "com.amazonaws.gamelift#TaggingFailedException" + { + "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon GameLift build resource for your game server software and stores the software\n for deployment to hosting resources. Combine game server binaries and dependencies into\n a single .zip file

\n \n

Use the CLI command \n upload-build\n to quickly and simply create a new build\n and upload your game build .zip file to Amazon GameLift Amazon S3. This helper command eliminates\n the need to explicitly manage access permissions.

\n
\n

Alternatively, use the CreateBuild action for the following\n scenarios:

\n \n

If successful, this action creates a new build resource with a unique build ID and\n places it in INITIALIZED status. When the build reaches READY\n status, 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": { + "type": "structure", + "members": { + "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 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 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 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 environment that your game server binaries run on. This value determines the type\n of fleet resources that you use for this build. If your game build contains multiple\n executables, they all must run on the same operating system. This parameter is required,\n and there's no default value. You can't change a build's operating system later.

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in \n the Amazon Linux 2 FAQs. \n For game servers\n that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the\n game server build to server SDK 5.x, and then deploy to AL2023 instances. See\n \n Migrate to Amazon GameLift server SDK version 5.\n

\n
" + } + }, + "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 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 Amazon GameLift. For more information see Integrate games\n with custom game servers. By default Amazon GameLift sets this value to\n 4.0.2.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#CreateBuildOutput": { + "type": "structure", + "members": { + "Build": { + "target": "com.amazonaws.gamelift#Build", + "traits": { + "smithy.api#documentation": "

The newly created build resource, including a unique build IDs and status.

" + } + }, + "UploadCredentials": { + "target": "com.amazonaws.gamelift#AwsCredentials", + "traits": { + "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 key.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.gamelift#CreateContainerFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#CreateContainerFleetInput" + }, + "output": { + "target": "com.amazonaws.gamelift#CreateContainerFleetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#ConflictException" + }, + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#LimitExceededException" + }, + { + "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game\n servers. Use this operation to define how to deploy a container architecture onto each\n fleet instance and configure fleet settings. You can create a container fleet in any\n Amazon Web Services Regions that Amazon GameLift supports for multi-location fleets. A container fleet can be\n deployed to a single location or multiple locations. Container fleets are deployed with\n Amazon Linux 2023 as the instance operating system.

\n

Define the fleet's container architecture using container group definitions. Each\n fleet can have one of the following container group types:

\n \n

Each container group can include the definition for one or more containers. A\n container definition specifies a container image that is stored in an Amazon Elastic Container Registry (Amazon ECR)\n public or private repository.

\n

\n Request options\n

\n

Use this operation to make the following types of requests. Most fleet settings have\n default values, so you can create a working fleet with a minimal configuration and\n default values, which you can customize later.

\n \n

\n Results\n

\n

If successful, this operation creates a new container fleet resource, places it in\n PENDING status, and initiates the fleet creation workflow. For fleets with container groups, this workflow\n starts a fleet deployment and transitions the status to ACTIVE. Fleets\n without a container group are placed in CREATED status.

\n

You can update most of the properties of a fleet, including container group\n definitions, and deploy the update across all fleet instances. Use a fleet update to\n deploy a new game server version update across the container fleet.

" + } + }, + "com.amazonaws.gamelift#CreateContainerFleetInput": { + "type": "structure", + "members": { + "FleetRoleArn": { + "target": "com.amazonaws.gamelift#ArnStringModel", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for an Identity and Access Management (IAM) role with permissions to run your\n containers on resources that are managed by Amazon GameLift. Use an IAM service role with the\n GameLiftContainerFleetPolicy managed policy attached. For more\n information, see Set up an IAM service\n role. You can't change this fleet property after the fleet is\n created.

\n

IAM role ARN values use the following pattern: arn:aws:iam::[Amazon Web Services account]:role/[role name].

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

A meaningful description of the container fleet.

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

A container group definition resource that describes how to deploy containers with\n your game server build and support software onto each fleet instance. You can specify\n the container group definition's name to use the latest version. Alternatively, provide\n an ARN value with a specific version number.

\n

Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.

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

The name of a container group definition resource that describes a set of axillary\n software. A fleet instance has one process for executables in this container group. A\n per-instance container group is optional. You can update the fleet to add or remove a\n per-instance container group at any time. You can specify the container group\n definition's name to use the latest version. Alternatively, provide an ARN value with a\n specific version number.

\n

Create a container group definition by calling CreateContainerGroupDefinition. \n This operation creates a ContainerGroupDefinition resource.

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

The set of port numbers to open on each fleet instance. A fleet's connection ports map\n to container ports that are configured in the fleet's container group definitions.

\n

By default, Amazon GameLift calculates an optimal port range based on your fleet\n configuration. To use the calculated range, don't set this parameter. The values\n are:

\n \n

You can also choose to manually set this parameter. When manually setting this\n parameter, you must use port numbers that match the fleet's inbound permissions port\n range.

\n \n

If you set values manually, Amazon GameLift no longer calculates a port range for you,\n even if you later remove the manual settings.

\n
" + } + }, + "InstanceInboundPermissions": { + "target": "com.amazonaws.gamelift#IpPermissionsList", + "traits": { + "smithy.api#documentation": "

The IP address ranges and port settings that allow inbound traffic to access game\n server processes and other processes on this fleet. As a best practice, when remotely\n accessing a fleet instance, we recommend opening ports only when you need them and\n closing them when you're finished.

\n

By default, Amazon GameLift calculates an optimal port range based on your fleet\n configuration. To use the calculated range, don't set this parameter. The values\n are:

\n \n

You can also choose to manually set this parameter. When manually setting this\n parameter, you must use port numbers that match the fleet's connection port\n range.

\n \n

If you set values manually, Amazon GameLift no longer calculates a port range for you,\n even if you later remove the manual settings.

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

The number of times to replicate the game server container group on each fleet\n instance.

\n

By default, Amazon GameLift calculates the maximum number of game server container groups that\n can fit on each instance. This calculation is based on the CPU and memory resources of\n the fleet's instance type). To use the calculated maximum, don't set this parameter. If\n you set this number manually, Amazon GameLift uses your value as long as it's less than the\n calculated maximum.

" + } }, - { - "target": "com.amazonaws.gamelift#UnauthorizedException" - } - ], - "traits": { - "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 Amazon 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 an Amazon GameLift Amazon S3 location, and (2)\n it creates a new build resource.

\n
\n

You can use the CreateBuild 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": { - "type": "structure", - "members": { - "Name": { + "InstanceType": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The Amazon EC2 instance type to use for all instances in the fleet. For multi-location\n fleets, the instance type must be available in the home region and all remote locations.\n Instance type determines the computing resources and processing power that's available\n to host your game servers. This includes including CPU, memory, storage, and networking\n capacity.

\n

By default, Amazon GameLift selects an instance type that fits the needs of your container\n groups and is available in all selected fleet locations. You can also choose to manually\n set this parameter. See Amazon Elastic Compute Cloud\n Instance Types for detailed descriptions of Amazon EC2 instance types.

\n

You can't update this fleet property later.

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

Version information associated with a build or script. Version strings don't need to be unique. You can change this value later.

" + "smithy.api#documentation": "

Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about\n when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

\n

By default, this property is set to ON_DEMAND.

\n

You can't update this fleet property later.

" } }, - "StorageLocation": { - "target": "com.amazonaws.gamelift#S3Location", + "Locations": { + "target": "com.amazonaws.gamelift#LocationConfigurationList", "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 can be found in\n your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.

" + "smithy.api#documentation": "

A set of locations to deploy container fleet instances to. You can add any Amazon Web Services\n Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more Amazon Web Services\n Region codes, such as us-west-2, or Local Zone names. Also include the\n fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of\n supported Regions and Local Zones, see Amazon GameLift service\n locations for managed hosting.

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

The operating system that your game server binaries run on. This value determines the\n type of fleet resources that you use for this build. If your game build contains\n multiple executables, they all must run on the same operating system. You must specify a\n valid operating system in this request. There is no default value. You can't change a\n build's operating system later.

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in \n the Amazon Linux 2 FAQs. \n For game servers\n that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the\n game server build to server SDK 5.x, and then deploy to AL2023 instances. See\n \n Migrate to Amazon GameLift server SDK version 5.\n

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

The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group \n to aggregate metrics for multiple fleets. You can specify an existing metric\n group name or use a new name to create a new metric group. Each fleet can have only one metric group, \n but you can change this value at any time.

" } }, - "Tags": { - "target": "com.amazonaws.gamelift#TagList", + "NewGameSessionProtectionPolicy": { + "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "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.

" + "smithy.api#documentation": "

Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively\n running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down\n fleet capacity or when retiring unhealthy instances. You can also set game session\n protection for individual game sessions using UpdateGameSession.

\n \n

By default, this property is set to NoProtection.

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

A server SDK version you used when integrating your game server build with Amazon GameLift. For more information see Integrate games\n with custom game servers. By default Amazon GameLift sets this value to\n 4.0.2.

" + "smithy.api#documentation": "

A policy that limits the number of game sessions that each individual player can create\n on instances in this fleet. The limit applies for a specified span of time.

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

A method for collecting container logs for the fleet. Amazon GameLift saves all standard\n output for each container in logs, including game session logs. You can select from the\n following methods:

\n \n

By default, this property is set to CLOUDWATCH.

\n

Amazon GameLift requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see FleetRoleArn).

" + } + }, + "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.

" } } }, @@ -1808,25 +2044,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.gamelift#CreateBuildOutput": { + "com.amazonaws.gamelift#CreateContainerFleetOutput": { "type": "structure", "members": { - "Build": { - "target": "com.amazonaws.gamelift#Build", - "traits": { - "smithy.api#documentation": "

The newly created build resource, including a unique build IDs and status.

" - } - }, - "UploadCredentials": { - "target": "com.amazonaws.gamelift#AwsCredentials", - "traits": { - "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", + "ContainerFleet": { + "target": "com.amazonaws.gamelift#ContainerFleet", "traits": { - "smithy.api#documentation": "

Amazon S3 location for your game build file, including bucket name and key.

" + "smithy.api#documentation": "

The properties for the new container fleet, including current status. All fleets are\n initially placed in PENDING status.

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

\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n

\n

Creates a ContainerGroupDefinition resource that describes a set of\n containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container\n group is similar to a container \"task\" and \"pod\". Each container group can have one or more\n containers.

\n

Use container group definitions when you create a container fleet. Container group\n definitions determine how Amazon GameLift deploys your containers to each instance in a container\n fleet.

\n

You can create two types of container groups, based on scheduling strategy:

\n \n

To create a container group definition, specify a group name, a list of container\n definitions, and maximum total CPU and memory requirements for the container group. Specify an\n operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI\n tool, you can pass in your container definitions as a JSON file.

\n \n

This operation requires Identity and Access Management (IAM) permissions to access container images in\n Amazon ECR repositories. See IAM permissions\n for Amazon GameLift for help setting the appropriate permissions.

\n
\n

If successful, this operation creates a new ContainerGroupDefinition resource\n with an ARN value assigned. You can't change the properties of a container group definition.\n Instead, create a new one.

\n

\n Learn more\n

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

Creates a ContainerGroupDefinition that describes a set of containers for\n hosting your game server with Amazon GameLift managed containers hosting. An Amazon GameLift container group\n is similar to a container task or pod. Use container group definitions when you create a\n container fleet with CreateContainerFleet.

\n

A container group definition determines how Amazon GameLift deploys your containers to each\n instance in a container fleet. You can maintain multiple versions of a container group\n definition.

\n

There are two types of container groups:

\n \n \n

This operation requires Identity and Access Management (IAM) permissions to access container images in\n Amazon ECR repositories. See IAM permissions\n for Amazon GameLift for help setting the appropriate permissions.

\n
\n

\n Request options\n

\n

Use this operation to make the following types of requests. You can specify values for the\n minimum required parameters and customize optional values later.

\n \n

\n Results\n

\n

If successful, this request creates a ContainerGroupDefinition resource and\n assigns a unique ARN value. You can update most properties of a container group definition by\n calling UpdateContainerGroupDefinition, and optionally save the update as a new version.

" } }, "com.amazonaws.gamelift#CreateContainerGroupDefinitionInput": { @@ -1880,44 +2104,54 @@ "smithy.api#required": {} } }, - "SchedulingStrategy": { - "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "ContainerGroupType": { + "target": "com.amazonaws.gamelift#ContainerGroupType", "traits": { - "smithy.api#documentation": "

The method for deploying the container group across fleet instances. A replica container\n group might have multiple copies on each fleet instance. A daemon container group has one copy\n per fleet instance. Default value is REPLICA.

" + "smithy.api#documentation": "

The type of container group being defined. Container group type determines how Amazon GameLift \n deploys the container group on each fleet instance.

\n

Default value: GAME_SERVER\n

" } }, - "TotalMemoryLimit": { + "TotalMemoryLimitMebibytes": { "target": "com.amazonaws.gamelift#ContainerTotalMemoryLimit", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The maximum amount of memory (in MiB) to allocate to the container group. All containers in\n the group share this memory. If you specify memory limits for individual containers, set this\n parameter based on the following guidelines. The value must be (1) greater than the sum of the\n soft memory limits for all containers in the group, and (2) greater than any individual\n container's hard memory limit.

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

The maximum amount of memory (in MiB) to allocate to the container group. All containers in\n the group share this memory. If you specify memory limits for an individual container, the\n total value must be greater than any individual container's memory limit.

\n

Default value: 1024

", "smithy.api#required": {} } }, - "TotalCpuLimit": { - "target": "com.amazonaws.gamelift#ContainerTotalCpuLimit", + "TotalVcpuLimit": { + "target": "com.amazonaws.gamelift#ContainerTotalVcpuLimit", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The maximum amount of CPU units to allocate to the container group. Set this parameter to an\n integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group\n share this memory. If you specify CPU limits for individual containers, set this parameter\n based on the following guidelines. The value must be equal to or greater than the sum of the\n CPU limits for all containers in the group.

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

The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024\n CPU units). All containers in the group share this memory. If you specify vCPU limits for\n individual containers, the total value must be equal to or greater than the sum of the CPU\n limits for all containers in the group.

\n

Default value: 1

", "smithy.api#required": {} } }, - "ContainerDefinitions": { - "target": "com.amazonaws.gamelift#ContainerDefinitionInputList", + "GameServerContainerDefinition": { + "target": "com.amazonaws.gamelift#GameServerContainerDefinitionInput", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Definitions for all containers in this group. Each container definition identifies the\n container image and specifies configuration settings for the container. See the \n Container fleet design guide for container guidelines.

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

The definition for the game server container in this group. Define a game server container\n only when the container group type is GAME_SERVER. Game server containers specify\n a container image with your game server build. You can pass in your container definitions as a\n JSON file.

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

One or more definition for support containers in this group. You can define a support\n container in any type of container group. You can pass in your container definitions as a JSON\n file.

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

The platform that is used by containers in the container group definition. All containers in\n a group must run on the same operating system.

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in \n the Amazon Linux 2 FAQs. \n For game servers\n that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the\n game server build to server SDK 5.x, and then deploy to AL2023 instances. See\n \n Migrate to Amazon GameLift server SDK version 5.\n

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

The platform that all containers in the group use. Containers in a group must run on the\n same operating system.

\n

Default value: AMAZON_LINUX_2023\n

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game\n servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the game\n server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to\n Amazon GameLift server SDK version 5.\n

\n
", "smithy.api#required": {} } }, + "VersionDescription": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A description for the initial version of this container group definition.

" + } + }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { @@ -1935,7 +2169,7 @@ "ContainerGroupDefinition": { "target": "com.amazonaws.gamelift#ContainerGroupDefinition", "traits": { - "smithy.api#documentation": "

The properties of the newly created container group definition resource. You use this resource \n to create a container fleet.

" + "smithy.api#documentation": "

The properties of the new container group definition resource. You can use this resource to\n create a container fleet.

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

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Creates a fleet of compute resources to host your game servers. Use this operation to\n set up the following types of fleets based on compute type:

\n

\n Managed EC2 fleet\n

\n

An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is\n deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the\n lifecycle of game server processes, which host game sessions for players. EC2 fleets can\n have instances in multiple locations. Each instance in the fleet is designated a\n Compute.

\n

To create an EC2 fleet, provide these required parameters:

\n \n

If successful, this operation creates a new fleet resource and places it in\n NEW status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance\n metrics or other actions on the fleet, create a development fleet with port 22/3389\n open. As a best practice, we recommend opening ports for remote access only when you\n need them and closing them when you're finished.

\n

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling\n on/off for each location.

\n

\n Managed container fleet\n

\n

A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture\n is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the\n containers on each fleet instance and controls the lifecycle of game server processes,\n which host game sessions for players. Container fleets can have instances in multiple\n locations. Each container on an instance that runs game server processes is registered\n as a Compute.

\n

To create a container fleet, provide these required parameters:

\n \n

If successful, this operation creates a new fleet resource and places it in\n NEW status while Amazon GameLift initiates the fleet creation workflow.

\n

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling\n on/off for each location.

\n

\n Anywhere fleet\n

\n

An Anywhere fleet represents compute resources that are not owned or managed by\n Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use\n one to host game servers with on-premises hardware or other game hosting solutions.

\n

To create an Anywhere fleet, provide these required parameters:

\n \n

If successful, this operation creates a new fleet resource and places it in\n ACTIVE status. You can register computes with a fleet in\n ACTIVE status.

\n

\n Learn more\n

\n

\n Setting up\n fleets\n

\n

\n Setting up a container fleet\n

\n

\n Debug fleet creation issues\n

\n

\n Multi-location fleets\n

" + "smithy.api#documentation": "

Creates a fleet of compute resources to host your game servers. Use this operation to\n set up the following types of fleets based on compute type:

\n

\n Managed EC2 fleet\n

\n

An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is\n deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the\n lifecycle of game server processes, which host game sessions for players. EC2 fleets can\n have instances in multiple locations. Each instance in the fleet is designated a\n Compute.

\n

To create an EC2 fleet, provide these required parameters:

\n \n

If successful, this operation creates a new fleet resource and places it in\n NEW status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance\n metrics or other actions on the fleet, create a development fleet with port 22/3389\n open. As a best practice, we recommend opening ports for remote access only when you\n need them and closing them when you're finished.

\n

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling\n on/off for each location.

\n

\n Anywhere fleet\n

\n

An Anywhere fleet represents compute resources that are not owned or managed by\n Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use\n one to host game servers with on-premises hardware or other game hosting solutions.

\n

To create an Anywhere fleet, provide these required parameters:

\n \n

If successful, this operation creates a new fleet resource and places it in\n ACTIVE status. You can register computes with a fleet in\n ACTIVE status.

\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": { @@ -2034,13 +2268,13 @@ "EC2InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "

The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.\n Instance type determines the computing resources that will be used to host your game\n servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for\n detailed descriptions of Amazon EC2 instance types.

" + "smithy.api#documentation": "

The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.\n Instance type determines the computing resources that will be used to host your game\n servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for\n detailed descriptions of Amazon EC2 instance types.

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

The IP address ranges and port settings that allow inbound traffic to access game\n server processes and other processes on this fleet. Set this parameter for EC2 and container \n fleets. You can leave this parameter empty when creating the fleet, but you must call \n UpdateFleetPortSettings to set it before players can connect to game sessions. \n As a best practice, we recommend \n opening ports for remote access only when you need them and closing them when you're finished. \n For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

\n

To manage inbound access for a container fleet, set this parameter to the same port\n numbers that you set for the fleet's connection port range. During the life of the\n fleet, update this parameter to control which connection ports are open to inbound\n traffic.

" + "smithy.api#documentation": "

The IP address ranges and port settings that allow inbound traffic to access game\n server processes and other processes on this fleet. Set this parameter for managed EC2 \n fleets. You can leave this parameter empty when creating the fleet, but you must call \n UpdateFleetPortSettings to set it before players can connect to game sessions. \n As a best practice, we recommend \n opening ports for remote access only when you need them and closing them when you're finished. \n For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

" } }, "NewGameSessionProtectionPolicy": { @@ -2052,7 +2286,7 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "

Instructions for how to launch and run server processes on the fleet. Set runtime\n configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this\n parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration\n defines one or more server process configurations. Each server process identifies a game\n executable or Realtime script file and the number of processes to run concurrently.

\n \n

This parameter replaces the parameters ServerLaunchPath and\n ServerLaunchParameters, which are still supported for backward\n compatibility.

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

Instructions for how to launch and run server processes on the fleet. Set runtime\n configuration for managed EC2 fleets. For an Anywhere fleets, set this\n parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration\n defines one or more server process configurations. Each server process identifies a game\n executable or Realtime script file and the number of processes to run concurrently.

\n \n

This parameter replaces the parameters ServerLaunchPath and\n ServerLaunchParameters, which are still supported for backward\n compatibility.

\n
" } }, "ResourceCreationLimitPolicy": { @@ -2088,7 +2322,7 @@ "InstanceRoleArn": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

A unique identifier for an IAM role with access permissions to other Amazon Web Services services. \n Any application that runs on an instance in the fleet--including install scripts, server processes, and other \n processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to.\n For more information about using the role with your game server builds, see \n \n Communicate with other Amazon Web Services resources from your fleets. This fleet property can't 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 fleet property can't be changed after the fleet is created.

" } }, "CertificateConfiguration": { @@ -2112,7 +2346,7 @@ "ComputeType": { "target": "com.amazonaws.gamelift#ComputeType", "traits": { - "smithy.api#documentation": "

The type of compute resource used to host your game servers.

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

The type of compute resource used to host your game servers.

\n " } }, "AnywhereConfiguration": { @@ -2126,12 +2360,6 @@ "traits": { "smithy.api#documentation": "

Prompts Amazon GameLift to generate a shared credentials file for the IAM role\n that's defined in InstanceRoleArn. The shared credentials file is stored on\n each fleet instance and refreshed as needed. Use shared credentials for applications\n that are deployed along with the game server executable, if the game server is\n integrated with server SDK version 5.x. For more information about using shared\n credentials, see Communicate\n with other Amazon Web Services resources from your fleets.

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

The container groups to deploy to instances in the container fleet and other fleet-level\n configuration settings. Use the CreateContainerGroupDefinition action\n to create container groups. A container fleet must have exactly one replica container\n group, and can optionally have one daemon container group. You can't change this\n property after you create the fleet.

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

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Adds remote locations to an EC2 or container fleet and begins populating the new\n locations with instances. The new instances conform to the fleet's instance type,\n auto-scaling, and other configuration settings.

\n \n

You can't add remote locations to a fleet that resides in an Amazon Web Services Region that\n doesn't support multiple locations. Fleets created prior to March 2021 can't support\n multiple locations.

\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. Amazon 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 Update fleet locations\n

\n

\n \n Amazon GameLift service locations for managed hosting.

" + "smithy.api#documentation": "

Adds remote locations to a managed EC2 fleet or managed container fleet and begins populating the new\n locations with instances. The new instances conform to the fleet's instance type,\n auto-scaling, and other configuration settings.

\n \n

You can't add remote locations to a fleet that resides in an Amazon Web Services Region that\n doesn't support multiple locations. Fleets created prior to March 2021 can't support\n multiple locations.

\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. Amazon 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 Update fleet locations\n

\n

\n \n Amazon GameLift service locations for managed hosting.

" } }, "com.amazonaws.gamelift#CreateFleetLocationsInput": { @@ -2481,7 +2709,7 @@ "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 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. For more information, see Start a game session.

" } }, "Location": { @@ -2555,13 +2783,13 @@ "TimeoutInSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

" + "smithy.api#documentation": "

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

" } }, "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.

" + "smithy.api#documentation": "

A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. \n\tUse multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement.\n\t Policies are evaluated in order starting with the lowest maximum latency value.

" } }, "Destinations": { @@ -2781,7 +3009,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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. 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": { @@ -2799,7 +3027,7 @@ "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 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.

" + "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. For more information, 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": { @@ -3098,7 +3326,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\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 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

" + "smithy.api#documentation": "

Creates a script resource for your Realtime Servers script. Realtime scripts are JavaScript files\n that provide configuration settings and optional custom game logic for your game. Script\n logic is executed during an active game session. To deploy Realtime Servers for hosting, create an\n Amazon GameLift managed fleet with the script.

\n

To create a script resource, specify a script name and provide the script file(s). The\n script files and all dependencies must be combined into a single .zip file. You can\n upload the .zip file from either of these locations:

\n \n

If the call is successful, Amazon GameLift creates a new script resource with a unique script\n ID. The script is uploaded to an Amazon S3 bucket that is owned by Amazon GameLift.

\n

\n Learn more\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": { @@ -3107,13 +3335,13 @@ "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to\n change this value later.

" + "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 associated with a build or script. Version strings don't need to be unique. You can use UpdateScript to\n change this value later.

" + "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\n change this value later.

" } }, "StorageLocation": { @@ -3401,13 +3629,68 @@ "smithy.api#input": {} } }, + "com.amazonaws.gamelift#DeleteContainerFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DeleteContainerFleetInput" + }, + "output": { + "target": "com.amazonaws.gamelift#DeleteContainerFleetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes all resources and information related to a container fleet and shuts down\n currently running fleet instances, including those in remote locations. The container\n fleet must be in ACTIVE status to be deleted.

\n

To delete a fleet, specify the fleet ID to be terminated. During the deletion process,\n the fleet status is changed to DELETING.

\n

\n Learn more\n

\n

\n Setting up Amazon GameLift\n Fleets\n

" + } + }, + "com.amazonaws.gamelift#DeleteContainerFleetInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for the container fleet to delete. You can use either the fleet ID\n or ARN value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#DeleteContainerFleetOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#DeleteContainerGroupDefinition": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteContainerGroupDefinitionInput" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.gamelift#DeleteContainerGroupDefinitionOutput" }, "errors": [ { @@ -3430,7 +3713,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n

\n

Deletes a container group definition resource. You can delete a container group definition\n if there are no fleets using the definition.

\n

To delete a container group definition, identify the resource to delete.

\n

\n Learn more\n

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

Deletes a container group definition. You can delete a container group definition if there\n are no fleets using the definition.

\n

\n Request options:\n

\n \n

\n Learn more\n

\n " } }, "com.amazonaws.gamelift#DeleteContainerGroupDefinitionInput": { @@ -3443,12 +3726,31 @@ "smithy.api#documentation": "

The unique identifier for the container group definition to delete. You can use either the Name or ARN\n value.

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

The specific version to delete.

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

The number of most recent versions to keep while deleting all older versions.

" + } } }, "traits": { "smithy.api#input": {} } }, + "com.amazonaws.gamelift#DeleteContainerGroupDefinitionOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#DeleteFleet": { "type": "operation", "input": { @@ -3863,6 +4165,9 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { @@ -4013,43 +4318,174 @@ { "target": "com.amazonaws.gamelift#NotFoundException" }, - { - "target": "com.amazonaws.gamelift#UnauthorizedException" - } - ], - "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..

\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": { - "type": "structure", - "members": { - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], + "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..

\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": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering\n connection record. You can use either the fleet ID or ARN value.

", + "smithy.api#required": {} + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for a VPC peering connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#DeleteVpcPeeringConnectionOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.gamelift#DeploymentConfiguration": { + "type": "structure", + "members": { + "ProtectionStrategy": { + "target": "com.amazonaws.gamelift#DeploymentProtectionStrategy", + "traits": { + "smithy.api#documentation": "

Determines how fleet deployment activity affects active game sessions on the fleet.\n With protection, a deployment honors game session protection, and delays actions that\n would interrupt a protected active game session until the game session ends. Without\n protection, deployment activity can shut down all running tasks, including active game\n sessions, regardless of game session protection.

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

Sets a minimum level of healthy tasks to maintain during deployment activity.

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

Determines what actions to take if a deployment fails. If the fleet is multi-location,\n this strategy applies across all fleet locations. With a rollback strategy, updated\n fleet instances are rolled back to the last successful deployment. Alternatively, you\n can maintain a few impaired containers for the purpose of debugging, while all other\n tasks return to the last successful deployment.

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

Set of rules for processing a deployment for a container fleet update.

" + } + }, + "com.amazonaws.gamelift#DeploymentDetails": { + "type": "structure", + "members": { + "LatestDeploymentId": { + "target": "com.amazonaws.gamelift#DeploymentId", + "traits": { + "smithy.api#documentation": "

A unique identifier for a fleet deployment.

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

Information about the most recent deployment for the container fleet.

" + } + }, + "com.amazonaws.gamelift#DeploymentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#DeploymentImpairmentStrategy": { + "type": "enum", + "members": { + "MAINTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAINTAIN" + } + }, + "ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK" + } + } + } + }, + "com.amazonaws.gamelift#DeploymentProtectionStrategy": { + "type": "enum", + "members": { + "WITH_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WITH_PROTECTION" + } + }, + "IGNORE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE_PROTECTION" + } + } + } + }, + "com.amazonaws.gamelift#DeploymentStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" + } + }, + "ROLLBACK_COMPLETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering\n connection record. You can use either the fleet ID or ARN value.

", - "smithy.api#required": {} + "smithy.api#enumValue": "ROLLBACK_COMPLETE" } }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "CANCELLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique identifier for a VPC peering connection.

", - "smithy.api#required": {} + "smithy.api#enumValue": "CANCELLED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.gamelift#DeleteVpcPeeringConnectionOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} } }, "com.amazonaws.gamelift#DeregisterCompute": { @@ -4075,7 +4511,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet.\n Deregistered computes can no longer host game sessions through Amazon GameLift.

\n

For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent\n handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the\n Agent, call this operation to deregister fleet computes.

\n

To deregister a compute, call this operation from the compute that's being\n deregistered and specify the compute name and the fleet ID.

" + "smithy.api#documentation": "

Removes a compute resource from an Amazon GameLift Anywhere fleet.\n Deregistered computes can no longer host game sessions through Amazon GameLift.

\n

For an Anywhere fleet that's running the Amazon GameLift Agent, the Agent\n handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the\n Agent, call this operation to deregister fleet computes.

\n

To deregister a compute, call this operation from the compute that's being\n deregistered and specify the compute name and the fleet ID.

" } }, "com.amazonaws.gamelift#DeregisterComputeInput": { @@ -4093,7 +4529,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unique identifier of the compute resource to deregister. For an Anywhere fleet\n compute, use the registered compute name. For a container fleet, use the compute name\n (for example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.

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

The unique identifier of the compute resource to deregister. For an Anywhere fleet\n compute, use the registered compute name.

", "smithy.api#required": {} } } @@ -4291,10 +4727,13 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all\n computes in a fleet, call ListCompute.

\n

To request information on a specific compute, provide the fleet ID and compute\n name.

\n

If successful, this operation returns details for the requested compute resource.\n Depending on the fleet's compute type, the result includes the following information:

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

Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all\n computes in a fleet, call ListCompute.

\n

To request information on a specific compute, provide the fleet ID and compute\n name.

\n

If successful, this operation returns details for the requested compute resource.\n Depending on the fleet's compute type, the result includes the following information:

\n " } }, "com.amazonaws.gamelift#DescribeComputeInput": { @@ -4312,7 +4751,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unique identifier of the compute resource to retrieve properties for. For an\n Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use\n the instance ID. For a container fleet, use the compute name (for example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.

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

The unique identifier of the compute resource to retrieve properties for. For an\n Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use\n the instance ID.

", "smithy.api#required": {} } } @@ -4335,6 +4774,65 @@ "smithy.api#output": {} } }, + "com.amazonaws.gamelift#DescribeContainerFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DescribeContainerFleetInput" + }, + "output": { + "target": "com.amazonaws.gamelift#DescribeContainerFleetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the properties for a container fleet. When requesting attributes for\n multiple fleets, use the pagination parameters to retrieve results as a set of\n sequential pages.

\n

\n Request options\n

\n \n

\n Results\n

\n

If successful, a ContainerFleet object is returned. This object includes\n the fleet properties, including information about the most recent deployment.

\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
" + } + }, + "com.amazonaws.gamelift#DescribeContainerFleetInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for the container fleet to retrieve. You can use either the fleet\n ID or ARN value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#DescribeContainerFleetOutput": { + "type": "structure", + "members": { + "ContainerFleet": { + "target": "com.amazonaws.gamelift#ContainerFleet", + "traits": { + "smithy.api#documentation": "

The properties for the requested container fleet, including current status.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#DescribeContainerGroupDefinition": { "type": "operation", "input": { @@ -4361,7 +4859,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n

\n

Retrieves the properties of a container group definition, including all container\n definitions in the group.

\n

To retrieve a container group definition, provide a resource identifier. If successful,\n this operation returns the complete properties of the container group definition.

\n

\n Learn more\n

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

Retrieves the properties of a container group definition, including all container\n definitions in the group.

\n

\n Request options:\n

\n \n

\n Results:\n

\n

If successful, this operation returns the complete properties of a container group\n definition version.

\n

\n Learn more\n

\n " } }, "com.amazonaws.gamelift#DescribeContainerGroupDefinitionInput": { @@ -4374,6 +4872,12 @@ "smithy.api#documentation": "

The unique identifier for the container group definition to retrieve properties for. You can use either the Name or\n ARN value.

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

The specific version to retrieve.

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

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing\n hardware and deployment configuration for instances in the fleet.

\n

You can use this operation 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 Amazon GameLift\n fleets\n

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

Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing\n hardware and deployment configuration for instances in the fleet.

\n

You can use this operation 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 Amazon GameLift\n fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4552,10 +5056,13 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Retrieves the resource capacity settings for one or more fleets. For a container\n fleet, this operation also returns counts for replica container groups.

\n

With multi-location fleets, this operation retrieves data for the fleet's home Region\n only. To retrieve capacity for remote locations, see \n DescribeFleetLocationCapacity.

\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\n property, which is set to the fleet's home Region. Capacity values are returned only for\n 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 Amazon GameLift\n fleets\n

\n

\n GameLift metrics for fleets\n

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

Retrieves the resource capacity settings for one or more fleets. For a container\n fleet, this operation also returns counts for game server container groups.

\n

With multi-location fleets, this operation retrieves data for the fleet's home Region\n only. To retrieve capacity for remote locations, see \n DescribeFleetLocationCapacity.

\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\n property, which is set to the fleet's home Region. Capacity values are returned only for\n 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 Amazon GameLift\n fleets\n

\n

\n GameLift metrics for fleets\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4610,6 +5117,77 @@ "smithy.api#output": {} } }, + "com.amazonaws.gamelift#DescribeFleetDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DescribeFleetDeploymentInput" + }, + "output": { + "target": "com.amazonaws.gamelift#DescribeFleetDeploymentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a managed container fleet deployment.

\n

\n Request options\n

\n \n

\n Results\n

\n

If successful, a FleetDeployment object is returned.

" + } + }, + "com.amazonaws.gamelift#DescribeFleetDeploymentInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for the container fleet. You can use either the fleet ID or ARN\n value.

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

A unique identifier for the deployment to return information for.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#DescribeFleetDeploymentOutput": { + "type": "structure", + "members": { + "FleetDeployment": { + "target": "com.amazonaws.gamelift#FleetDeployment", + "traits": { + "smithy.api#documentation": "

The requested deployment information.

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

If the deployment is for a multi-location fleet, the requests returns the deployment\n status in each fleet location.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#DescribeFleetEvents": { "type": "operation", "input": { @@ -4630,6 +5208,9 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { @@ -4828,7 +5409,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. For a container fleet, this operation also returns counts\n for replica container groups.

\n

Use this operation to retrieve capacity information for a fleet's remote location or\n home Region (you can also retrieve home Region capacity by calling\n 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 Amazon GameLift\n fleets\n

\n

\n Amazon GameLift service locations for managed hosting

\n

\n GameLift metrics for fleets\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. For a managed container fleet, this operation also returns counts\n for game server container groups.

\n

Use this operation to retrieve capacity information for a fleet's remote location or\n home Region (you can also retrieve home Region capacity by calling\n 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 Amazon GameLift\n fleets\n

\n

\n Amazon GameLift service locations for managed hosting

\n

\n GameLift metrics for fleets\n

" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacityInput": { @@ -4962,7 +5543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a fleet's inbound connection permissions. Connection permissions specify IP\n addresses and port settings that incoming traffic can use to access server processes in\n the fleet. Game server processes that are running in the fleet must use a port that\n falls within this range. To connect to game server processes on a container fleet, the\n port settings should include one or more of the fleet's connection ports.

\n

Use this operation in the following ways:

\n \n

If successful, a set of IpPermission objects is returned for the\n requested fleet ID. When specifying a location, this operation returns a pending status.\n If the requested fleet has been deleted, the result set is empty.

\n

\n Learn more\n

\n

\n Setting up Amazon GameLift\n fleets\n

" + "smithy.api#documentation": "

Retrieves a fleet's inbound connection permissions. Inbound permissions specify IP\n addresses and port settings that incoming traffic can use to access server processes in\n the fleet. Game server processes that are running in the fleet must use a port that\n falls within this range. To connect to game server processes on a managed container fleet, the\n port settings should include one or more of the container fleet's connection ports.

\n

Use this operation in the following ways:

\n \n

If successful, a set of IpPermission objects is returned for the\n requested fleet ID. When specifying a location, this operation returns a pending status.\n If the requested fleet has been deleted, the result set is empty.

\n

\n Learn more\n

\n

\n Setting up Amazon GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsInput": { @@ -6087,7 +6668,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a fleet's runtime configuration settings. The runtime configuration\n determines which server processes run, and how, on computes in the fleet. For managed\n EC2 fleets, the runtime configuration describes server processes that run on each fleet\n instance. For container fleets, the runtime configuration describes server processes\n that run in each replica container group. You can update a fleet's runtime configuration\n at any time using UpdateRuntimeConfiguration.

\n

To get the current runtime configuration for a fleet, provide the 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 Amazon GameLift\n fleets\n

\n

\n Running multiple\n processes on a fleet\n

" + "smithy.api#documentation": "

Retrieves a fleet's runtime configuration settings. The runtime configuration\n determines which server processes run, and how they run, and how many run concurrently \n on computes in managed EC2 and Anywhere fleets. You can update a fleet's runtime configuration\n at any time using UpdateRuntimeConfiguration.

\n

To get the current runtime configuration for a fleet, provide the 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 Amazon GameLift\n fleets\n

\n

\n Running multiple\n processes on a fleet\n

" } }, "com.amazonaws.gamelift#DescribeRuntimeConfigurationInput": { @@ -7575,7 +8156,7 @@ "EventCode": { "target": "com.amazonaws.gamelift#EventCode", "traits": { - "smithy.api#documentation": "

The type of event being logged.

\n

\n Fleet state transition events:\n

\n \n

\n Fleet creation events (ordered by fleet creation\n activity):\n

\n \n

\n VPC peering events:\n

\n \n

\n Spot instance events:\n

\n \n

\n Server process events:\n

\n \n

\n Game session events:\n

\n \n

\n Other fleet events:\n

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

The type of event being logged.

\n

\n Fleet state transition events:\n

\n \n

\n Fleet creation events (ordered by fleet creation\n activity):\n

\n \n

\n VPC peering events:\n

\n \n

\n Container group events:\n

\n \n

\n Spot instance events:\n

\n \n

\n Server process events:\n

\n \n

\n Game session events:\n

\n \n

\n Other fleet events:\n

\n " } }, "Message": { @@ -7670,6 +8251,30 @@ "smithy.api#enumValue": "FLEET_STATE_ERROR" } }, + "FLEET_STATE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_PENDING" + } + }, + "FLEET_STATE_CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_CREATING" + } + }, + "FLEET_STATE_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_CREATED" + } + }, + "FLEET_STATE_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STATE_UPDATING" + } + }, "FLEET_INITIALIZATION_FAILED": { "target": "smithy.api#Unit", "traits": { @@ -7760,6 +8365,18 @@ "smithy.api#enumValue": "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT" } }, + "SERVER_PROCESS_SDK_INITIALIZATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_SDK_INITIALIZATION_FAILED" + } + }, + "SERVER_PROCESS_MISCONFIGURED_CONTAINER_PORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_PROCESS_MISCONFIGURED_CONTAINER_PORT" + } + }, "GAME_SESSION_ACTIVATION_TIMEOUT": { "target": "smithy.api#Unit", "traits": { @@ -7772,58 +8389,142 @@ "smithy.api#enumValue": "FLEET_CREATION_EXTRACTING_BUILD" } }, - "FLEET_CREATION_RUNNING_INSTALLER": { + "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" + } + }, + "INSTANCE_REPLACED_UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_REPLACED_UNHEALTHY" + } + }, + "FLEET_CREATION_COMPLETED_INSTALLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_CREATION_COMPLETED_INSTALLER" + } + }, + "FLEET_CREATION_FAILED_INSTALLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_CREATION_FAILED_INSTALLER" + } + }, + "COMPUTE_LOG_UPLOAD_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPUTE_LOG_UPLOAD_FAILED" + } + }, + "GAME_SERVER_CONTAINER_GROUP_CRASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GAME_SERVER_CONTAINER_GROUP_CRASHED" + } + }, + "PER_INSTANCE_CONTAINER_GROUP_CRASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_INSTANCE_CONTAINER_GROUP_CRASHED" + } + }, + "GAME_SERVER_CONTAINER_GROUP_REPLACED_UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GAME_SERVER_CONTAINER_GROUP_REPLACED_UNHEALTHY" + } + }, + "LOCATION_STATE_PENDING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLEET_CREATION_RUNNING_INSTALLER" + "smithy.api#enumValue": "LOCATION_STATE_PENDING" } }, - "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG": { + "LOCATION_STATE_CREATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG" + "smithy.api#enumValue": "LOCATION_STATE_CREATING" } }, - "FLEET_VPC_PEERING_SUCCEEDED": { + "LOCATION_STATE_CREATED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLEET_VPC_PEERING_SUCCEEDED" + "smithy.api#enumValue": "LOCATION_STATE_CREATED" } }, - "FLEET_VPC_PEERING_FAILED": { + "LOCATION_STATE_ACTIVATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLEET_VPC_PEERING_FAILED" + "smithy.api#enumValue": "LOCATION_STATE_ACTIVATING" } }, - "FLEET_VPC_PEERING_DELETED": { + "LOCATION_STATE_ACTIVE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLEET_VPC_PEERING_DELETED" + "smithy.api#enumValue": "LOCATION_STATE_ACTIVE" } }, - "INSTANCE_INTERRUPTED": { + "LOCATION_STATE_UPDATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INSTANCE_INTERRUPTED" + "smithy.api#enumValue": "LOCATION_STATE_UPDATING" } }, - "INSTANCE_RECYCLED": { + "LOCATION_STATE_ERROR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INSTANCE_RECYCLED" + "smithy.api#enumValue": "LOCATION_STATE_ERROR" } }, - "FLEET_CREATION_COMPLETED_INSTALLER": { + "LOCATION_STATE_DELETING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLEET_CREATION_COMPLETED_INSTALLER" + "smithy.api#enumValue": "LOCATION_STATE_DELETING" } }, - "FLEET_CREATION_FAILED_INSTALLER": { + "LOCATION_STATE_DELETED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLEET_CREATION_FAILED_INSTALLER" + "smithy.api#enumValue": "LOCATION_STATE_DELETED" } } } @@ -7906,7 +8607,11 @@ "com.amazonaws.gamelift#FleetArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:.*:fleet\\/fleet-\\S+$" + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:.*:[a-z]*fleet\\/[a-z]*fleet-[a-zA-Z0-9\\-]+$" } }, "com.amazonaws.gamelift#FleetAttributes": { @@ -7933,7 +8638,7 @@ "InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance type that the fleet uses. Instance type determines the computing\n resources of each instance in the fleet, including CPU, memory, storage, and networking\n capacity. See Amazon Elastic Compute Cloud Instance\n Types for detailed descriptions. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".

" + "smithy.api#documentation": "

The Amazon EC2 instance type that the fleet uses. Instance type determines the computing\n resources of each instance in the fleet, including CPU, memory, storage, and networking\n capacity. See Amazon Elastic Compute Cloud Instance\n Types for detailed descriptions. This attribute is used with\n fleets where ComputeType is \"EC2\".

" } }, "Description": { @@ -8011,13 +8716,13 @@ "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. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".

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

The type of game session protection to set on all new instances that are started in\n the fleet. This attribute is used with\n fleets where ComputeType is \"EC2\".

\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.\n This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in \n the Amazon Linux 2 FAQs. \n For game servers\n that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the\n game server build to server SDK 5.x, and then deploy to AL2023 instances. See\n \n Migrate to Amazon GameLift server SDK version 5.\n

\n
" + "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.\n This attribute is used with\n fleets where ComputeType is \"EC2\".

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs.\n For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x,\n first update the game server build to server SDK 5.x, and then deploy to AL2023\n instances. See \n Migrate to Amazon GameLift server SDK version 5.\n

\n
" } }, "ResourceCreationLimitPolicy": { @@ -8026,19 +8731,19 @@ "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. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".

" + "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. This attribute is used with\n fleets where ComputeType is \"EC2\".

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

A list of fleet activity that has been suspended using StopFleetActions. \n This includes fleet auto-scaling. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".

" + "smithy.api#documentation": "

A list of fleet activity that has been suspended using StopFleetActions. \n This includes fleet auto-scaling. This attribute is used with\n fleets where ComputeType is \"EC2\".

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

A unique identifier for an IAM role with access permissions to other Amazon Web Services services. \n Any application that runs on an instance in the fleet--including install scripts, server processes, and other \n processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to.\n For more information about using the role with your game server builds, see \n \n Communicate with other Amazon Web Services resources from your fleets. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".

" + "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 attribute is used with\n fleets where ComputeType is \"EC2\".

" } }, "CertificateConfiguration": { @@ -8056,24 +8761,18 @@ "AnywhereConfiguration": { "target": "com.amazonaws.gamelift#AnywhereConfiguration", "traits": { - "smithy.api#documentation": "

\n This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet.\n These attributes are included for fleets with compute type CONTAINER only.\n This attribute is used with fleets where ComputeType is \"Container\".

" + "smithy.api#documentation": "

Amazon GameLift Anywhere configuration options.

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

Indicates that fleet instances maintain a shared credentials file for the IAM role\n defined in InstanceRoleArn. Shared credentials allow applications that are\n deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used \n only when the game server is integrated with the\n server SDK version 5.x. For more information about using shared credentials, see Communicate\n with other Amazon Web Services resources from your fleets.\n This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".

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

A set of properties that describe the container groups that are deployed to the fleet.\n These attributes are included for fleets with compute type\n CONTAINER.

" + "smithy.api#documentation": "

Indicates that fleet instances maintain a shared credentials file for the IAM role\n defined in InstanceRoleArn. Shared credentials allow applications that are\n deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used \n only when the game server is integrated with the\n server SDK version 5.x. For more information about using shared credentials, see Communicate\n with other Amazon Web Services resources from your fleets.\n This attribute is used with\n fleets where ComputeType is \"EC2\".

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

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on\n the fleet's compute type, as follows:

\n \n

\n Returned by:\n DescribeFleetAttributes\n

" + "smithy.api#documentation": "

Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on\n the fleet's compute type, as follows:

\n \n

\n Returned by:\n DescribeFleetAttributes\n

" } }, "com.amazonaws.gamelift#FleetAttributesList": { @@ -8082,6 +8781,16 @@ "target": "com.amazonaws.gamelift#FleetAttributes" } }, + "com.amazonaws.gamelift#FleetBinaryArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:/-]+$" + } + }, "com.amazonaws.gamelift#FleetCapacity": { "type": "structure", "members": { @@ -8115,15 +8824,15 @@ "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.

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

\n This property is used with the Amazon GameLift containers feature, which is currently in public preview. The number and status of replica container groups in a container fleet.

" + "smithy.api#documentation": "

The number and status of game server container groups deployed in a container fleet.

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

Current resource capacity settings for managed EC2 fleets and container fleets. For\n multi-location fleets, location values might refer to a fleet's remote location or its\n home Region.

\n

\n Returned by:\n DescribeFleetCapacity, DescribeFleetLocationCapacity, UpdateFleetCapacity\n

" + "smithy.api#documentation": "

Current resource capacity settings for managed EC2 fleets and managed container fleets. For\n multi-location fleets, location values might refer to a fleet's remote location or its\n home Region.

\n

\n Returned by:\n DescribeFleetCapacity, DescribeFleetLocationCapacity, UpdateFleetCapacity\n

" } }, "com.amazonaws.gamelift#FleetCapacityExceededException": { @@ -8144,10 +8853,82 @@ "target": "com.amazonaws.gamelift#FleetCapacity" } }, + "com.amazonaws.gamelift#FleetDeployment": { + "type": "structure", + "members": { + "DeploymentId": { + "target": "com.amazonaws.gamelift#DeploymentId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the deployment.

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

A unique identifier for the container fleet.

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

The unique identifier for the version of the game server container group definition\n that is being deployed.

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

The unique identifier for the version of the game server container group definition to\n roll back to if deployment fails.

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

The unique identifier for the version of the per-instance container group definition\n that is being deployed.

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

The unique identifier for the version of the per-instance container group definition\n to roll back to if deployment fails.

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

The status of fleet deployment activity in the location.

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

Instructions for how to deploy updates to a container fleet and what actions to take\n if the deployment fails.

" + } + }, + "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\").

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

Describes a container fleet deployment with updates to the fleet.

" + } + }, + "com.amazonaws.gamelift#FleetDeployments": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#FleetDeployment" + } + }, "com.amazonaws.gamelift#FleetId": { "type": "string", "traits": { - "smithy.api#pattern": "^fleet-\\S+$" + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-z]*fleet-[a-zA-Z0-9\\-]+$" } }, "com.amazonaws.gamelift#FleetIdList": { @@ -8164,7 +8945,11 @@ "com.amazonaws.gamelift#FleetIdOrArn": { "type": "string", "traits": { - "smithy.api#pattern": "^fleet-\\S+|^arn:.*:fleet\\/fleet-\\S+$" + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-z]*fleet-[a-zA-Z0-9\\-]+$|^arn:.*:[a-z]*fleet\\/[a-z]*fleet-[a-zA-Z0-9\\-]+$" } }, "com.amazonaws.gamelift#FleetIdOrArnList": { @@ -8355,6 +9140,9 @@ { "target": "com.amazonaws.gamelift#CreateBuild" }, + { + "target": "com.amazonaws.gamelift#CreateContainerFleet" + }, { "target": "com.amazonaws.gamelift#CreateContainerGroupDefinition" }, @@ -8403,6 +9191,9 @@ { "target": "com.amazonaws.gamelift#DeleteBuild" }, + { + "target": "com.amazonaws.gamelift#DeleteContainerFleet" + }, { "target": "com.amazonaws.gamelift#DeleteContainerGroupDefinition" }, @@ -8454,6 +9245,9 @@ { "target": "com.amazonaws.gamelift#DescribeCompute" }, + { + "target": "com.amazonaws.gamelift#DescribeContainerFleet" + }, { "target": "com.amazonaws.gamelift#DescribeContainerGroupDefinition" }, @@ -8466,6 +9260,9 @@ { "target": "com.amazonaws.gamelift#DescribeFleetCapacity" }, + { + "target": "com.amazonaws.gamelift#DescribeFleetDeployment" + }, { "target": "com.amazonaws.gamelift#DescribeFleetEvents" }, @@ -8556,9 +9353,18 @@ { "target": "com.amazonaws.gamelift#ListCompute" }, + { + "target": "com.amazonaws.gamelift#ListContainerFleets" + }, { "target": "com.amazonaws.gamelift#ListContainerGroupDefinitions" }, + { + "target": "com.amazonaws.gamelift#ListContainerGroupDefinitionVersions" + }, + { + "target": "com.amazonaws.gamelift#ListFleetDeployments" + }, { "target": "com.amazonaws.gamelift#ListFleets" }, @@ -8634,6 +9440,12 @@ { "target": "com.amazonaws.gamelift#UpdateBuild" }, + { + "target": "com.amazonaws.gamelift#UpdateContainerFleet" + }, + { + "target": "com.amazonaws.gamelift#UpdateContainerGroupDefinition" + }, { "target": "com.amazonaws.gamelift#UpdateFleetAttributes" }, @@ -9755,6 +10567,161 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.gamelift#GameServerContainerDefinition": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#documentation": "

The container definition identifier. Container names are unique within a container group\n definition.

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

Indicates that the container relies on the status of other containers in the same\n container group during startup and shutdown sequences. A container might have dependencies on\n multiple containers.

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

A mount point that binds a path inside the container to a file or directory on the host\n system and lets it access the file or directory.

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

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.

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

The URI to the image that Amazon GameLift uses when deploying this container to a container fleet.\n For a more specific identifier, see ResolvedImageDigest.

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

The set of ports that are available to bind to processes in the container. For example, a\n game server process requires a container port to allow game clients to connect to it.\n Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container\n ports to externally accessible connection ports, which are assigned as needed from the\n container fleet's ConnectionPortRange.

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

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of\n the container image manifest.

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

The Amazon GameLift server SDK version that the game server is integrated with. Only game servers\n using 5.2.0 or higher are compatible with container fleets.

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

Describes the game server container in an existing game server container group. A game\n server container identifies a container image with your game server build. A game server\n container is automatically considered essential; if an essential container fails, the entire\n container group restarts.

\n

You can update a container definition and deploy the updates to an existing fleet. When\n creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput.

\n

\n Part of:\n ContainerGroupDefinition\n

\n

\n Returned by:\n DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition\n

" + } + }, + "com.amazonaws.gamelift#GameServerContainerDefinitionInput": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A string that uniquely identifies the container definition within a container\n group.

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

Establishes dependencies between this container and the status of other containers in the\n same container group. A container can have dependencies on multiple different containers.

\n

You can use dependencies to establish a startup/shutdown sequence across the container\n group. For example, you might specify that ContainerB has a\n START dependency on ContainerA. This dependency means that\n ContainerB can't start until after ContainerA has\n started. This dependency is reversed on shutdown, which means that\n ContainerB must shut down before ContainerA can\n shut down.

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

A mount point that binds a path inside the container to a file or directory on the host\n system and lets it access the file or directory.

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

A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.

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

The location of the container image to deploy to a container fleet. Provide an image in an\n Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and\n Amazon Web Services Region where you're creating the container group definition. For limits on image size,\n see Amazon GameLift endpoints and\n quotas. You can use any of the following image URI formats:

\n ", + "smithy.api#required": {} + } + }, + "PortConfiguration": { + "target": "com.amazonaws.gamelift#ContainerPortConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A set of ports that Amazon GameLift can assign to processes in the container. Processes, must be\n assigned a container port to accept inbound traffic connections. For example, a game server\n process requires a container port to allow game clients to connect to it. Container ports\n aren't directly accessed by inbound traffic. Instead, Amazon GameLift maps container ports to\n externally accessible connection ports (see the container fleet property\n ConnectionPortRange).

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

The Amazon GameLift server SDK version that the game server is integrated with. Only game servers\n using 5.2.0 or higher are compatible with container fleets.

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

Describes the configuration for a container that runs your game server executable. This\n definition includes container configuration, resources, and start instructions. Use this data\n type when creating or updating a game server container group definition. For properties of a\n deployed container, see GameServerContainerDefinition. A game server\n container is automatically considered essential; if an essential container fails, the entire\n container group restarts.

\n

\n Use with: \n CreateContainerGroupDefinition, UpdateContainerGroupDefinition\n

" + } + }, + "com.amazonaws.gamelift#GameServerContainerGroupCounts": { + "type": "structure", + "members": { + "PENDING": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The number of container groups that are starting up but haven't yet registered.

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

\n The number of container groups that have active game sessions.\n

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

\n The number of container groups that have no active game sessions.\n

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

The number of container groups that are in the process of shutting down.

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

The number and status of game server container groups that are deployed across a container fleet. \n Combine this count with the number of server processes that each game server container group runs \n to learn how many game sessions the fleet is capable of hosting concurrently. For example, if a \n fleet has 50 game server container groups, and the game server container in each group runs 1 game server \n process, then the fleet has the capacity to run host 50 game sessions at a time.

\n

\n Returned by:\n DescribeFleetCapacity, DescribeFleetLocationCapacity\n

" + } + }, + "com.amazonaws.gamelift#GameServerContainerGroupsPerInstance": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, "com.amazonaws.gamelift#GameServerData": { "type": "string", "traits": { @@ -10775,7 +11742,7 @@ "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 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. For more information, see Start a game session.

" } }, "MatchmakerData": { @@ -10842,6 +11809,26 @@ "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#GameSessionCreationLimitPolicy": { + "type": "structure", + "members": { + "NewGameSessionsPerCreator": { + "target": "com.amazonaws.gamelift#WholeNumber", + "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 evaluates when a player tries to create a new game session. On receiving a\n CreateGameSession request, Amazon GameLift checks that the player (identified\n by CreatorId) has created fewer than game session limit in the specified\n time period.

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

The time span used in evaluating the resource creation limit policy.

" + } + } + }, + "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, Amazon 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#GameSessionData": { "type": "string", "traits": { @@ -10913,7 +11900,7 @@ "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": { @@ -10955,7 +11942,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 Amazon Web Services Regions.

" + "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.

" } }, "StartTime": { @@ -10997,7 +11984,7 @@ "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. For more information, see Start a game session.

" } }, "MatchmakerData": { @@ -11064,13 +12051,13 @@ "TimeoutInSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

" + "smithy.api#documentation": "

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

" } }, "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.

" + "smithy.api#documentation": "

A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. \n\tUse multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement.\n\t Policies are evaluated in order starting with the lowest maximum latency value.

" } }, "Destinations": { @@ -11236,10 +12223,13 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed\n fleet. This operation is not used with Amazon GameLift Anywhere fleets

\n

To request access, specify the compute name and the fleet ID. If successful, this\n operation returns a set of temporary Amazon Web Services credentials, including a two-part access key\n and a session token.

\n

\n EC2 fleets\n

\n

With an EC2 fleet (where compute type is EC2), use these credentials with\n Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User\n Guide.

\n

\n Container fleets\n

\n

With a container fleet (where compute type is CONTAINER), use\n these credentials and the target value with SSM to connect to the fleet instance where\n the container is running. After you're connected to the instance, use Docker commands to\n interact with the container.

\n

\n Learn more\n

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

Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed\n fleet. This operation is not used with Amazon GameLift Anywhere fleets.

\n

\n Request options\n

\n

To request access to a compute, specify the compute name and the fleet ID.

\n

\n Results\n

\n

If successful, this operation returns a set of temporary Amazon Web Services credentials, including\n a two-part access key and a session token.

\n " } }, "com.amazonaws.gamelift#GetComputeAccessInput": { @@ -11257,7 +12247,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique identifier for the compute resource that you want to connect to. For an EC2\n fleet compute, use the instance ID. For a container fleet, use the compute name (for\n example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.

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

A unique identifier for the compute resource that you want to connect to. For an EC2\n fleet compute, use the instance ID. Use\n ListCompute to retrieve compute identifiers.

", "smithy.api#required": {} } } @@ -11302,7 +12292,13 @@ "Target": { "target": "com.amazonaws.gamelift#SessionTarget", "traits": { - "smithy.api#documentation": "

(For container fleets only) The instance ID where the compute resource is\n running.

" + "smithy.api#documentation": "

The instance ID where the compute resource is running.

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

For a managed container fleet, a list of containers on the compute. Use the container\n runtime ID with Docker commands to connect to a specific container.

" } } }, @@ -11330,10 +12326,13 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { - "smithy.api#documentation": "

Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift\n Anywhere fleet or container fleet. Game servers that are running on the compute use this\n token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server\n SDK action InitSDK(). Authentication tokens are valid for a limited time\n span, so you need to request a fresh token before the current token expires.

\n

Use this operation based on the fleet compute type:

\n \n

\n Learn more\n

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

Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift\n fleet. Game servers that are running on the compute use this token to communicate\n with the Amazon GameLift service, such as when calling the Amazon GameLift server SDK action\n InitSDK(). Authentication tokens are valid for a limited time span, so\n you need to request a fresh token before the current token expires.

\n

\n Request options\n

\n \n

\n Learn more\n

\n " } }, "com.amazonaws.gamelift#GetComputeAuthTokenInput": { @@ -11351,7 +12350,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the compute resource you are requesting the authentication token for. For\n an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance,\n use the instance ID. For a container fleet, use the compute name (for example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.

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

The name of the compute resource you are requesting the authentication token for. For\n an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance,\n use the instance ID.

", "smithy.api#required": {} } } @@ -11596,7 +12595,7 @@ "DnsName": { "target": "com.amazonaws.gamelift#DnsName", "traits": { - "smithy.api#documentation": "

The DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" + "smithy.api#documentation": "

The DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" } }, "OperatingSystem": { @@ -11739,6 +12738,16 @@ "target": "com.amazonaws.gamelift#Instance" } }, + "com.amazonaws.gamelift#InstancePathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^\\/[\\s\\S]*$" + } + }, "com.amazonaws.gamelift#InstanceRoleCredentialsProvider": { "type": "enum", "members": { @@ -11872,7 +12881,7 @@ } }, "traits": { - "smithy.api#documentation": "

A range of IP addresses and port settings that allow inbound traffic to connect to\n processes on an instance in a fleet. Processes are assigned an IP address/port number\n combination, which must fall into the fleet's allowed ranges. For container fleets, the\n port settings must use the same port numbers as the fleet's connection ports.

\n

For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging\n and one for UDP.

" + "smithy.api#documentation": "

A range of IP addresses and port settings that allow inbound traffic to connect to\n processes on an instance in a fleet. Processes are assigned an IP address/port number\n combination, which must fall into the fleet's allowed ranges. For managed container fleets, the\n port settings must use the same port numbers as the fleet's connection ports.

\n

For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging\n and one for UDP.

" } }, "com.amazonaws.gamelift#IpPermissionsList": { @@ -12158,7 +13167,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "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, don't specify a value.

" + "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.

" } } }, @@ -12203,10 +13212,13 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Retrieves information on the compute resources in an Amazon GameLift fleet.

\n

To request a list of computes, specify the fleet ID. Use the pagination parameters to\n retrieve results in a set of sequential pages.

\n

You can filter the result set by location.

\n

If successful, this operation returns information on all computes in the requested\n fleet. Depending on the fleet's compute type, the result includes the following\n information:

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

Retrieves information on the compute resources in an Amazon GameLift fleet. Use the pagination\n parameters to retrieve results in a set of sequential pages.

\n

\n Request options:\n

\n \n

\n Results:\n

\n

If successful, this operation returns information on a set of computes. Depending on\n the type of fleet, the result includes the following information:

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -12229,7 +13241,19 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere\n fleet, use a custom location. For a multi-location EC2 or container fleet, provide a\n Amazon Web Services Region or Local Zone code (for example: us-west-2 or\n us-west-2-lax-1).

" + "smithy.api#documentation": "

The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere\n fleet, use a custom location. For a managed fleet, provide a\n Amazon Web Services Region or Local Zone code (for example: us-west-2 or\n us-west-2-lax-1).

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

For computes in a managed container fleet, the name of the deployed container group\n definition.

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

The status of computes in a managed container fleet, based on the success of the\n latest update deployment.

\n " } }, "Limit": { @@ -12249,6 +13273,23 @@ "smithy.api#input": {} } }, + "com.amazonaws.gamelift#ListComputeInputStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + } + } + }, "com.amazonaws.gamelift#ListComputeOutput": { "type": "structure", "members": { @@ -12269,6 +13310,176 @@ "smithy.api#output": {} } }, + "com.amazonaws.gamelift#ListContainerFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#ListContainerFleetsInput" + }, + "output": { + "target": "com.amazonaws.gamelift#ListContainerFleetsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a collection of container fleet resources in an Amazon Web Services Region. For fleets\n that have multiple locations, this operation retrieves fleets based on their home Region\n only.

\n

\n Request options\n

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, this operation returns a collection of container fleets that match the request\n parameters. A NextToken value is also returned if there are more result pages to\n retrieve.

\n \n

Fleet IDs are returned in no particular order.

\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContainerFleets", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.gamelift#ListContainerFleetsInput": { + "type": "structure", + "members": { + "ContainerGroupDefinitionName": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn", + "traits": { + "smithy.api#documentation": "

The container group definition to filter the list on. Use this parameter to retrieve\n only those fleets that use the specified container group definition. You can specify the\n container group definition's name to get fleets with the latest versions. Alternatively,\n provide an ARN value to get fleets with a specific version number.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#ListContainerFleetsOutput": { + "type": "structure", + "members": { + "ContainerFleets": { + "target": "com.amazonaws.gamelift#ContainerFleetList", + "traits": { + "smithy.api#documentation": "

A collection of container fleet objects for all fleets that match the request\n criteria.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.gamelift#ListContainerGroupDefinitionVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#ListContainerGroupDefinitionVersionsInput" + }, + "output": { + "target": "com.amazonaws.gamelift#ListContainerGroupDefinitionVersionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves all versions of a container group definition. Use the pagination parameters to\n retrieve results in a set of sequential pages.

\n

\n Request options:\n

\n \n

\n Results:\n

\n

If successful, this operation returns the complete properties of a set of container group\n definition versions that match the request.

\n \n

This operation returns the list of container group definitions in descending version\n order (latest first).

\n
\n

\n Learn more\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContainerGroupDefinitions", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.gamelift#ListContainerGroupDefinitionVersionsInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for the container group definition to retrieve properties for. You can use either the Name or\n ARN value.

", + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.gamelift#ListContainerGroupDefinitionVersionsLimit", + "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.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#ListContainerGroupDefinitionVersionsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.gamelift#ListContainerGroupDefinitionVersionsOutput": { + "type": "structure", + "members": { + "ContainerGroupDefinitions": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionList", + "traits": { + "smithy.api#documentation": "

A result set of container group definitions that match the request.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#ListContainerGroupDefinitions": { "type": "operation", "input": { @@ -12292,7 +13503,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n

\n

Retrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container\n groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of\n sequential pages.

\n \n

This operation returns the list of container group definitions in no particular order.

\n
\n

\n Learn more\n

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

Retrieves container group definitions for the Amazon Web Services account and Amazon Web Services Region. Use the pagination parameters to retrieve results in a set of sequential\n pages.

\n

This operation returns only the latest version of each definition. To retrieve all\n versions of a container group definition, use ListContainerGroupDefinitionVersions.

\n

\n Request options:\n

\n \n

\n Results:\n

\n

If successful, this operation returns the complete properties of a set of container group\n definition versions that match the request.

\n \n

This operation returns the list of container group definitions in no particular order.

\n
\n

\n Learn more\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -12304,10 +13515,10 @@ "com.amazonaws.gamelift#ListContainerGroupDefinitionsInput": { "type": "structure", "members": { - "SchedulingStrategy": { - "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "ContainerGroupType": { + "target": "com.amazonaws.gamelift#ContainerGroupType", "traits": { - "smithy.api#documentation": "

The type of container group definitions to retrieve.

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

The type of container group to retrieve. Container group type determines how Amazon GameLift\n deploys the container group on each fleet instance.

" } }, "Limit": { @@ -12317,7 +13528,7 @@ } }, "NextToken": { - "target": "com.amazonaws.gamelift#NonEmptyString", + "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.

" } @@ -12332,21 +13543,102 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 10 + "max": 100 + } + } + }, + "com.amazonaws.gamelift#ListContainerGroupDefinitionsOutput": { + "type": "structure", + "members": { + "ContainerGroupDefinitions": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionList", + "traits": { + "smithy.api#documentation": "

A result set of container group definitions that match the request.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.gamelift#ListFleetDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#ListFleetDeploymentsInput" + }, + "output": { + "target": "com.amazonaws.gamelift#ListFleetDeploymentsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a collection of container fleet deployments in an Amazon Web Services Region.

\n

\n Request options\n

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

\n Results\n

\n

If successful, this operation returns a list of deployments that match the request\n parameters. A NextToken value is also returned if there are more result pages to\n retrieve.

\n \n

Fleet IDs are returned in no particular order.

\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FleetDeployments", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.gamelift#ListFleetDeploymentsInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the container fleet. You can use either the fleet ID or ARN\n value.

" + } + }, + "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.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.gamelift#ListContainerGroupDefinitionsOutput": { + "com.amazonaws.gamelift#ListFleetDeploymentsOutput": { "type": "structure", "members": { - "ContainerGroupDefinitions": { - "target": "com.amazonaws.gamelift#ContainerGroupDefinitionList", + "FleetDeployments": { + "target": "com.amazonaws.gamelift#FleetDeployments", "traits": { - "smithy.api#documentation": "

A result set of container group definitions that match the request.

" + "smithy.api#documentation": "

The requested deployment information.

" } }, "NextToken": { - "target": "com.amazonaws.gamelift#NonEmptyString", + "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.

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

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the\n result set to find only those fleets that are deployed with a specific build or script.\n For fleets that have multiple locations, this operation retrieves fleets based on their\n home Region only.

\n

You can use operation in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, this operation returns a list of fleet IDs that match the request\n parameters. A NextToken value is also returned if there are more result pages to\n retrieve.

\n \n

Fleet IDs are returned in no particular order.

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

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the\n result set to find only those fleets that are deployed with a specific build or script.\n For fleets that have multiple locations, this operation retrieves fleets based on their\n home Region only.

\n

You can use operation in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, this operation returns a list of fleet IDs that match the request\n parameters. A NextToken value is also returned if there are more result pages to\n retrieve.

\n \n

Fleet IDs are returned in no particular order.

\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -12403,12 +13695,6 @@ "smithy.api#documentation": "

A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a\n specified script. Use either the script ID or ARN value.

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

The container group definition name to request fleets for. Use this parameter to\n return only fleets that are deployed with the specified container group\n definition.

" - } - }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { @@ -12723,7 +14009,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "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, don't specify a value.

" + "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.

" } } }, @@ -12771,6 +14057,9 @@ }, { "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { @@ -12862,7 +14151,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

A remote location where a multi-location fleet can deploy game servers for game\n hosting.

" + "smithy.api#documentation": "

A remote location where a multi-location fleet can deploy game servers for game\n hosting.

" } }, "com.amazonaws.gamelift#LocationConfigurationList": { @@ -12991,6 +14280,88 @@ } } }, + "com.amazonaws.gamelift#LocationalDeployment": { + "type": "structure", + "members": { + "DeploymentStatus": { + "target": "com.amazonaws.gamelift#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of fleet deployment activity in the location.

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

For a multi-location container fleet, describes the progress of a deployment across\n all fleet locations.

" + } + }, + "com.amazonaws.gamelift#LocationalDeployments": { + "type": "map", + "key": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString" + }, + "value": { + "target": "com.amazonaws.gamelift#LocationalDeployment" + } + }, + "com.amazonaws.gamelift#LogConfiguration": { + "type": "structure", + "members": { + "LogDestination": { + "target": "com.amazonaws.gamelift#LogDestination", + "traits": { + "smithy.api#documentation": "

The type of log collection to use for a fleet.

\n " + } + }, + "S3BucketName": { + "target": "com.amazonaws.gamelift#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If log destination is S3, logs are sent to the specified Amazon S3 bucket name.

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

If log destination is CLOUDWATCH, logs are sent to the specified log group in Amazon CloudWatch.

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

A method for collecting container logs for the fleet. Amazon GameLift saves all standard\n output for each container in logs, including game session logs. You can select from the\n following methods:

" + } + }, + "com.amazonaws.gamelift#LogDestination": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "CLOUDWATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH" + } + }, + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + } + }, + "com.amazonaws.gamelift#LogGroupArnStringModel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:/\\-\\*]+$" + } + }, "com.amazonaws.gamelift#MatchedPlayerSession": { "type": "structure", "members": { @@ -13101,7 +14472,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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. 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": { @@ -13125,7 +14496,7 @@ "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 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.

" + "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. For more information, 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": { @@ -13410,6 +14781,15 @@ } } }, + "com.amazonaws.gamelift#MaximumGameServerContainerGroupsPerInstance": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, "com.amazonaws.gamelift#MetricGroup": { "type": "string", "traits": { @@ -13508,6 +14888,15 @@ } } }, + "com.amazonaws.gamelift#MinimumHealthyPercentage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30, + "max": 75 + } + } + }, "com.amazonaws.gamelift#NonBlankAndLengthConstraintString": { "type": "string", "traits": { @@ -13592,7 +14981,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation failed because Amazon GameLift has not yet finished validating this compute. We\n recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential\n backoffs and jitter.

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

The operation failed because Amazon GameLift has not yet finished validating this compute. We\n recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential\n backoffs and jitter.

", "smithy.api#error": "client" } }, @@ -14127,6 +15516,9 @@ }, { "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { @@ -14276,7 +15668,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Registers a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift\n Anywhere fleet or a container fleet.

\n

For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent\n handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the\n Agent, call this operation to register fleet computes.

\n

To register a compute, give the compute a name (must be unique within the\n fleet) and specify the compute resource's DNS name or IP address. Provide a \n fleet ID and a fleet location to associate with the compute being registered. You can\n optionally include the path to a TLS certificate on the compute resource.

\n

If successful, this operation returns compute details, including an Amazon GameLift SDK\n endpoint or Agent endpoint. Game server processes running on the compute can use this\n endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK\n endpoint in its call to the Amazon GameLift server SDK action InitSDK().

\n

To view compute details, call DescribeCompute with the compute name.

\n

\n Learn more\n

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

Registers a compute resource in an Amazon GameLift Anywhere fleet.

\n

For an Anywhere fleet that's running the Amazon GameLift Agent, the Agent\n handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the\n Agent, call this operation to register fleet computes.

\n

To register a compute, give the compute a name (must be unique within the\n fleet) and specify the compute resource's DNS name or IP address. Provide a \n fleet ID and a fleet location to associate with the compute being registered. You can\n optionally include the path to a TLS certificate on the compute resource.

\n

If successful, this operation returns compute details, including an Amazon GameLift SDK\n endpoint or Agent endpoint. Game server processes running on the compute can use this\n endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK\n endpoint in its call to the Amazon GameLift server SDK action InitSDK().

\n

To view compute details, call DescribeCompute with the compute name.

\n

\n Learn more\n

\n " } }, "com.amazonaws.gamelift#RegisterComputeInput": { @@ -14428,47 +15820,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.gamelift#ReplicaContainerGroupCounts": { - "type": "structure", - "members": { - "PENDING": { - "target": "com.amazonaws.gamelift#WholeNumber", - "traits": { - "smithy.api#documentation": "

The number of container groups that are starting up but have not yet registered.

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

\n The number of container groups that have active game sessions.\n

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

\n The number of container groups that have no active game sessions.\n

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

The number of container groups that are in the process of shutting down.

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

\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

The number and status of replica container groups that are deployed across a fleet with\n compute type CONTAINER. This information, combined with the number of server\n processes being hosted per container group (see RuntimeConfiguration), tells you\n how many game sessions the fleet is currently capable of hosting concurrently.

\n

\n Returned by:\n DescribeFleetCapacity, DescribeFleetLocationCapacity\n

" - } - }, - "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 5000 - } - } - }, "com.amazonaws.gamelift#RequestUploadCredentials": { "type": "operation", "input": { @@ -14753,7 +16104,7 @@ "MaxConcurrentGameSessionActivations": { "target": "com.amazonaws.gamelift#MaxConcurrentGameSessionActivations", "traits": { - "smithy.api#documentation": "

The number of game sessions in status ACTIVATING to allow on an instance or container.\n This setting limits the instance resources that can be used for new game activations at\n any one time.

" + "smithy.api#documentation": "

The number of game sessions in status ACTIVATING to allow on an instance.\n This setting limits the instance resources that can be used for new game activations at\n any one time.

" } }, "GameSessionActivationTimeoutSeconds": { @@ -14764,7 +16115,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

A set of instructions that define the set of server processes to run on computes in a\n fleet. Server processes run either an executable in a custom game build or a Realtime Servers\n script. Amazon GameLift launches the processes, manages their life cycle, and replaces them as\n needed. Computes check regularly for an updated runtime configuration.

\n

On a container fleet, the Amazon GameLift Agent uses the runtime configuration to manage the\n lifecycle of server processes in a replica container group.

\n

An Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes defined 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.

" + "smithy.api#documentation": "

A set of instructions that define the set of server processes to run on computes in a\n fleet. Server processes run either an executable in a custom game build or a Realtime Servers\n script. Amazon GameLift launches the processes, manages their life cycle, and replaces them as\n needed. Computes check regularly for an updated runtime configuration.

\n

An Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes defined 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": { @@ -14985,13 +16336,13 @@ "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names don't need to be unique.

" + "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique.

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

Version information associated with a build or script. Version strings don't need to be unique.

" + "smithy.api#documentation": "

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

" } }, "SizeOnDisk": { @@ -15170,7 +16521,7 @@ "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The number of server processes using this configuration that run concurrently on each\n instance or container..

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

The number of server processes using this configuration that run concurrently on each\n instance or compute.

", "smithy.api#required": {} } } @@ -15346,7 +16697,7 @@ } ], "traits": { - "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.

" + "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, submit a new request to the same\n queue or a different queue.

" } }, "com.amazonaws.gamelift#StartGameSessionPlacementInput": { @@ -15391,7 +16742,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 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.

" + "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 it\n can offer the best possible gameplay experience for the players.

" } }, "DesiredPlayerSessions": { @@ -15403,7 +16754,7 @@ "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. For more information, see Start a game session.

" } } }, @@ -15597,7 +16948,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, Amazon GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity. To restart fleet actions again, call \n StartFleetActions.

\n

\n Learn more\n

\n

\n Setting up Amazon GameLift\n Fleets\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, Amazon GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity. To restart fleet actions again, call \n StartFleetActions.

\n

\n Learn more\n

\n

\n Setting up Amazon GameLift\n Fleets\n

" } }, "com.amazonaws.gamelift#StopFleetActionsInput": { @@ -15718,52 +17069,222 @@ { "target": "com.amazonaws.gamelift#InternalServiceException" }, - { - "target": "com.amazonaws.gamelift#InvalidRequestException" + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "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\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": { + "type": "structure", + "members": { + "TicketId": { + "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#StopMatchmakingOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.gamelift#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString" + } + }, + "com.amazonaws.gamelift#StringModel": { + "type": "string" + }, + "com.amazonaws.gamelift#SupportContainerDefinition": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#documentation": "

The container definition identifier. Container names are unique within a container group\n definition.

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

Indicates that the container relies on the status of other containers in the same\n container group during its startup and shutdown sequences. A container might have dependencies\n on multiple containers.

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

A mount point that binds a path inside the container to a file or directory on the host\n system and lets it access the file or directory.

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

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.

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

Indicates whether the container is vital to the container group. If an essential container\n fails, the entire container group restarts.

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

A configuration for a non-terminal health check. A support container automatically\n restarts if it stops functioning or if it fails this health check.

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

The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific\n identifier, see ResolvedImageDigest.

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

The amount of memory that Amazon GameLift makes available to the container. If memory limits\n aren't set for an individual container, the container shares the container group's total\n memory allocation.

\n

\n Related data type: \n ContainerGroupDefinition$TotalMemoryLimitMebibytes\n

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

A set of ports that allow access to the container from external users. Processes running\n in the container can bind to a one of these ports. Container ports aren't directly accessed by\n inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports,\n which are assigned as needed from the container fleet's\n ConnectionPortRange.

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

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of\n the container image manifest.

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

The number of vCPU units that are reserved for the container. If no resources are\n reserved, the container shares the total vCPU limit for the container group.

\n

\n Related data type: \n ContainerGroupDefinition$TotalVcpuLimit\n

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

Describes a support container in a container group. A support container might be in a game\n server container group or a per-instance container group. Support containers don't run game\n server processes.

\n

You can update a support container definition and deploy the updates to an existing fleet.\n When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput.

\n

\n Part of:\n ContainerGroupDefinition\n

\n

\n Returned by:\n DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition\n

" + } + }, + "com.amazonaws.gamelift#SupportContainerDefinitionInput": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A string that uniquely identifies the container definition within a container\n group.

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

Establishes dependencies between this container and the status of other containers in the\n same container group. A container can have dependencies on multiple different containers.

\n

.

\n

You can use dependencies to establish a startup/shutdown sequence across the container\n group. For example, you might specify that ContainerB has a\n START dependency on ContainerA. This dependency means that\n ContainerB can't start until after ContainerA has\n started. This dependency is reversed on shutdown, which means that\n ContainerB must shut down before ContainerA can\n shut down.

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

A mount point that binds a path inside the container to a file or directory on the host\n system and lets it access the file or directory.

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

A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.

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

Flags the container as vital for the container group to function properly. If an essential\n container fails, the entire container group restarts. At least one support container in a\n per-instance container group must be essential. When flagging a container as essential, also\n configure a health check so that the container can signal that it's healthy.

" + } }, - { - "target": "com.amazonaws.gamelift#NotFoundException" + "HealthCheck": { + "target": "com.amazonaws.gamelift#ContainerHealthCheck", + "traits": { + "smithy.api#documentation": "

Configuration for a non-terminal health check. A container automatically restarts if it\n stops functioning. With a health check, you can define additional reasons to flag a container\n as unhealthy and restart it. If an essential container fails a health check, the entire\n container group restarts.

" + } }, - { - "target": "com.amazonaws.gamelift#UnsupportedRegionException" - } - ], - "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\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": { - "type": "structure", - "members": { - "TicketId": { - "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", + "ImageUri": { + "target": "com.amazonaws.gamelift#ImageUriString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket.

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

The location of the container image to deploy to a container fleet. Provide an image in an\n Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and\n Amazon Web Services Region where you're creating the container group definition. For limits on image size,\n see Amazon GameLift endpoints and\n quotas. You can use any of the following image URI formats:

\n ", "smithy.api#required": {} } + }, + "MemoryHardLimitMebibytes": { + "target": "com.amazonaws.gamelift#ContainerMemoryLimit", + "traits": { + "smithy.api#documentation": "

A specified amount of memory (in MiB) to reserve for this container. If you don't specify\n a container-specific memory limit, the container shares the container group's total memory\n allocation.

\n

\n Related data type: \n ContainerGroupDefinition TotalMemoryLimitMebibytes\n

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

A set of ports that Amazon GameLift can assign to processes in the container. Any processes that\n accept inbound traffic connections must be assigned a port from this set. The container port\n range must be large enough to assign one to each process in the container that needs one.

\n

Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container\n ports to externally accessible connection ports, which are assigned as needed from the\n container fleet's ConnectionPortRange.

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

The number of vCPU units to reserve for this container. The container can use more\n resources when needed, if available. If you don't reserve CPU units for this container, it\n shares the container group's total vCPU limit.

\n

\n Related data type: \n ContainerGroupDefinition TotalCpuLimit\n

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

Describes a support container in a container group. You can define a support container in\n either a game server container group or a per-instance container group. Support containers\n don't run game server processes.

\n

This definition includes container configuration, resources, and start instructions. Use\n this data type when creating or updating a container group definition. For properties of a\n deployed support container, see SupportContainerDefinition.

\n

\n Use with: \n CreateContainerGroupDefinition, UpdateContainerGroupDefinition\n

" } }, - "com.amazonaws.gamelift#StopMatchmakingOutput": { - "type": "structure", - "members": {}, + "com.amazonaws.gamelift#SupportContainerDefinitionInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#SupportContainerDefinitionInput" + }, "traits": { - "smithy.api#output": {} + "smithy.api#length": { + "min": 0, + "max": 10 + } } }, - "com.amazonaws.gamelift#StringList": { + "com.amazonaws.gamelift#SupportContainerDefinitionList": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString" + "target": "com.amazonaws.gamelift#SupportContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } } }, - "com.amazonaws.gamelift#StringModel": { - "type": "string" - }, "com.amazonaws.gamelift#SuspendGameServerGroup": { "type": "operation", "input": { @@ -15905,6 +17426,9 @@ }, { "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { @@ -16054,6 +17578,9 @@ }, { "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { @@ -16205,13 +17732,13 @@ "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label associated with a build. Build names don't need to be unique.

" + "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique.

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

Version information associated with a build or script. Version strings don't need to be unique.

" + "smithy.api#documentation": "

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

" } } }, @@ -16233,6 +17760,253 @@ "smithy.api#output": {} } }, + "com.amazonaws.gamelift#UpdateContainerFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#UpdateContainerFleetInput" + }, + "output": { + "target": "com.amazonaws.gamelift#UpdateContainerFleetOutput" + }, + "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#NotReadyException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties of a managed container fleet. Depending on the properties being\n updated, this operation might initiate a fleet deployment. You can track deployments for\n a fleet using DescribeFleetDeployment.

\n

\n Request options\n

\n

As with CreateContainerFleet, many fleet properties use common defaults or are\n calculated based on the fleet's container group definitions.

\n \n

Changes to the following properties initiate a fleet deployment:

\n \n

\n Results\n

\n

If successful, this operation updates the container fleet resource, and might initiate\n a new deployment of fleet resources using the deployment configuration provided. A\n deployment replaces existing fleet instances with new instances that are deployed with\n the updated fleet properties. The fleet is placed in UPDATING status until\n the deployment is complete, then return to ACTIVE.

\n

You can have only one update deployment active at a time for a fleet. If a second\n update request initiates a deployment while another deployment is in progress, the first\n deployment is cancelled.

" + } + }, + "com.amazonaws.gamelift#UpdateContainerFleetInput": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for the container fleet to update. You can use either the fleet ID\n or ARN value.

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

The name or ARN value of a new game server container group definition to deploy on the\n fleet. If you're updating the fleet to a specific version of a container group\n definition, use the ARN value and include the version number. If you're updating the\n fleet to the latest version of a container group definition, you can use the name value.\n You can't remove a fleet's game server container group definition, you can only update\n or replace it with another definition.

\n

Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

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

The name or ARN value of a new per-instance container group definition to deploy on\n the fleet. If you're updating the fleet to a specific version of a container group\n definition, use the ARN value and include the version number. If you're updating the\n fleet to the latest version of a container group definition, you can use the name\n value.

\n

Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

\n

To remove a fleet's per-instance container group definition, leave this parameter empty\n and use the parameter RemoveAttributes.

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

The number of times to replicate the game server container group on each fleet\n instance. By default, Amazon GameLift calculates the maximum number of game server container\n groups that can fit on each instance. You can remove this property value to use the\n calculated value, or set it manually. If you set this number manually, Amazon GameLift uses your\n value as long as it's less than the calculated maximum.

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

A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift\n calculates an optimal port range based on your fleet configuration. If you previously\n set this parameter manually, you can't reset this to use the calculated settings.

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

A set of ports to add to the container fleet's inbound permissions.

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

A set of ports to remove from the container fleet's inbound permissions.

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

Instructions for how to deploy updates to a container fleet, if the fleet update\n initiates a deployment. The deployment configuration lets you determine how to replace\n fleet instances and what actions to take if the deployment fails.

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

A meaningful description of the container fleet.

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

The name of an Amazon Web Services CloudWatch metric group to add this fleet to.

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

The game session protection policy to apply to all new game sessions that are started\n in this fleet. Game sessions that already exist are not affected.

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

A policy that limits the number of game sessions that each individual player can create\n on instances in this fleet. The limit applies for a specified span of time.

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

The method for collecting container logs for the fleet.

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

If set, this update removes a fleet's per-instance container group definition. You\n can't remove a fleet's game server container group definition.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#UpdateContainerFleetOutput": { + "type": "structure", + "members": { + "ContainerFleet": { + "target": "com.amazonaws.gamelift#ContainerFleet", + "traits": { + "smithy.api#documentation": "

A collection of container fleet objects for all fleets that match the request\n criteria.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.gamelift#UpdateContainerGroupDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#UpdateContainerGroupDefinitionInput" + }, + "output": { + "target": "com.amazonaws.gamelift#UpdateContainerGroupDefinitionOutput" + }, + "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#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties in an existing container group definition. This operation doesn't\n replace the definition. Instead, it creates a new version of the definition and saves it\n separately. You can access all versions that you choose to retain.

\n

The only property you can't update is the container group type.

\n

\n Request options:\n

\n \n

\n Results:\n

\n

If successful, this operation returns the complete properties of the new container group\n definition version.

\n

If the container group definition version is used in an active fleets, the update\n automatically initiates a new fleet deployment of the new version. You can track a fleet's \n deployments using ListFleetDeployments.

" + } + }, + "com.amazonaws.gamelift#UpdateContainerGroupDefinitionInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

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

An updated definition for the game server container in this group. Define a game server\n container only when the container group type is GAME_SERVER. You can pass in your\n container definitions as a JSON file.

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

One or more definitions for support containers in this group. You can define a support\n container in any type of container group. You can pass in your container definitions as a JSON\n file.

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

The maximum amount of memory (in MiB) to allocate to the container group. All containers in\n the group share this memory. If you specify memory limits for an individual container, the\n total value must be greater than any individual container's memory limit.

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

The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024\n CPU units). All containers in the group share this memory. If you specify vCPU limits for\n individual containers, the total value must be equal to or greater than the sum of the CPU\n limits for all containers in the group.

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

A description for this update to the container group definition.

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

The container group definition version to update. The new version starts with values from\n the source version, and then updates values included in this request.

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

The platform that all containers in the group use. Containers in a group must run on the\n same operating system.

\n \n

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game\n servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the game\n server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to\n Amazon GameLift server SDK version 5.\n

\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#UpdateContainerGroupDefinitionOutput": { + "type": "structure", + "members": { + "ContainerGroupDefinition": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinition", + "traits": { + "smithy.api#documentation": "

The properties of the updated container group definition version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#UpdateFleetAttributes": { "type": "operation", "input": { @@ -16294,7 +18068,7 @@ "NewGameSessionProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "

The game session protection policy to apply to all new game sessions created in this\n fleet. Game sessions that already exist are not affected. You can set protection for\n individual game sessions using UpdateGameSession .

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

The game session protection policy to apply to all new game sessions created in this\n fleet. Game sessions that already exist are not affected. You can set protection for\n individual game sessions using UpdateGameSession.

\n " } }, "ResourceCreationLimitPolicy": { @@ -16375,7 +18149,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n

\n

Updates capacity settings for a managed EC2 fleet or container fleet. For these\n fleets, you adjust capacity by changing the number of instances in the fleet. Fleet\n capacity determines the number of game sessions and players that the fleet can host\n based on its configuration. For fleets with multiple locations, use this operation to\n manage capacity settings in each location individually.

\n

Use this operation to set these fleet capacity properties:

\n \n

To update capacity for a fleet's home Region, or if the fleet has no remote\n locations, omit the Location parameter. The fleet must be in\n ACTIVE status.

\n

To update capacity for a fleet's remote location, set the\n Location parameter to the location to update. The location must be in\n ACTIVE status.

\n

If successful, Amazon GameLift updates the capacity settings and returns the identifiers for\n the updated fleet and/or location. If a requested change to desired capacity exceeds the\n instance type's limit, the LimitExceeded exception occurs.

\n

Updates often prompt an immediate change in fleet capacity, such as when current\n capacity is different than the new desired capacity or outside the new limits. In this\n scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet\n location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.

\n

\n Learn more\n

\n

\n Scaling fleet\n capacity\n

" + "smithy.api#documentation": "

Updates capacity settings for a managed EC2 fleet or managed container fleet. For these\n fleets, you adjust capacity by changing the number of instances in the fleet. Fleet\n capacity determines the number of game sessions and players that the fleet can host\n based on its configuration. For fleets with multiple locations, use this operation to\n manage capacity settings in each location individually.

\n

Use this operation to set these fleet capacity properties:

\n \n

To update capacity for a fleet's home Region, or if the fleet has no remote\n locations, omit the Location parameter. The fleet must be in\n ACTIVE status.

\n

To update capacity for a fleet's remote location, set the\n Location parameter to the location to update. The location must be in\n ACTIVE status.

\n

If successful, Amazon GameLift updates the capacity settings and returns the identifiers for\n the updated fleet and/or location. If a requested change to desired capacity exceeds the\n instance type's limit, the LimitExceeded exception occurs.

\n

Updates often prompt an immediate change in fleet capacity, such as when current\n capacity is different than the new desired capacity or outside the new limits. In this\n scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet\n location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.

\n

\n Learn more\n

\n

\n Scaling fleet\n capacity\n

" } }, "com.amazonaws.gamelift#UpdateFleetCapacityInput": { @@ -16436,7 +18210,7 @@ "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { - "smithy.api#documentation": "

The remote location being updated, expressed as an Amazon Web Services Region code, such as\n 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.

" } } }, @@ -16821,13 +18595,13 @@ "TimeoutInSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600.

" + "smithy.api#documentation": "

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

" } }, "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 policies.

" + "smithy.api#documentation": "

A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. \n\tUse multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement.\n\t Policies are evaluated in order starting with the lowest maximum latency value. When updating policies, provide a complete collection of policies.

" } }, "Destinations": { @@ -16961,7 +18735,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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. 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": { @@ -16979,7 +18753,7 @@ "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 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.

" + "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. For more information, 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": { @@ -17042,7 +18816,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the runtime configuration for the specified fleet. The runtime configuration\n tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2\n fleets, it determines what server processes to run on each fleet instance. For container\n fleets, it describes what server processes to run in each replica container group. You\n can update a fleet's runtime configuration at any time after the fleet is created; it\n does not need to be in 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. Fleet computes\n that run game server processes regularly check for and receive updated runtime\n configurations. The computes immediately take action to comply with the new\n configuration by launching new server processes or by not replacing existing processes\n when they shut down. Updating a fleet's runtime configuration never affects existing\n server processes.

\n

\n Learn more\n

\n

\n Setting up Amazon GameLift\n fleets\n

" + "smithy.api#documentation": "

Updates the runtime configuration for the specified fleet. The runtime configuration\n tells Amazon GameLift how to launch server processes on computes in managed EC2 and Anywhere fleets. You\n can update a fleet's runtime configuration at any time after the fleet is created; it\n does not need to be in 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. Fleet computes\n that run game server processes regularly check for and receive updated runtime\n configurations. The computes immediately take action to comply with the new\n configuration by launching new server processes or by not replacing existing processes\n when they shut down. Updating a fleet's runtime configuration never affects existing\n server processes.

\n

\n Learn more\n

\n

\n Setting up Amazon GameLift\n fleets\n

" } }, "com.amazonaws.gamelift#UpdateRuntimeConfigurationInput": { @@ -17123,13 +18897,13 @@ "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names don't need to be unique.

" + "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique.

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

Version information associated with a build or script. Version strings don't need to be unique.

" + "smithy.api#documentation": "

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

" } }, "StorageLocation": { diff --git a/codegen/sdk-codegen/aws-models/payment-cryptography.json b/codegen/sdk-codegen/aws-models/payment-cryptography.json index e588cb15cc5..34c9f70680a 100644 --- a/codegen/sdk-codegen/aws-models/payment-cryptography.json +++ b/codegen/sdk-codegen/aws-models/payment-cryptography.json @@ -2113,7 +2113,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.

\n

This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

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

Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.

\n

This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2126,6 +2126,12 @@ "com.amazonaws.paymentcryptography#ListAliasesInput": { "type": "structure", "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "

The keyARN for which you want to list all aliases.

" + } + }, "NextToken": { "target": "com.amazonaws.paymentcryptography#NextToken", "traits": { @@ -3419,7 +3425,9 @@ "Value": { "target": "com.amazonaws.paymentcryptography#TagValue", "traits": { - "smithy.api#documentation": "

The value of the tag.

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

The value of the tag.

", + "smithy.api#required": {} } } }, @@ -3520,7 +3528,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 256 } } @@ -3582,7 +3590,8 @@ "min": 2, "max": 4096 }, - "smithy.api#pattern": "^[0-9A-F]+$" + "smithy.api#pattern": "^[0-9A-F]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.paymentcryptography#TrustedCertificatePublicKey": { @@ -3816,7 +3825,8 @@ "min": 16, "max": 4096 }, - "smithy.api#pattern": "^[0-9A-F]+$" + "smithy.api#pattern": "^[0-9A-F]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.paymentcryptography#WrappedKeyMaterialFormat": { diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 9b3af7257ed..292b9650661 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -4519,7 +4519,7 @@ "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB cluster will fail if the DB major version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB cluster will fail if the DB major version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } } }, @@ -27074,7 +27074,7 @@ "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } } }, @@ -27439,7 +27439,7 @@ "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } } }, @@ -27798,7 +27798,7 @@ "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" + "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } } },