Configures a transfer task, which defines where and how DataSync moves your\n data.
\nA task includes a source location, destination location, and the options for how and\n when you want to transfer your data (such as bandwidth limits, scheduling, among other\n options).
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nConfigures a task, which defines where and how DataSync transfers your\n data.
\nA task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nThe Amazon Resource Name (ARN) of the source location for the task.
", + "smithy.api#documentation": "Specifies the ARN of your transfer's source location.
", "smithy.api#required": {} } }, "DestinationLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.\n
", + "smithy.api#documentation": "Specifies the ARN of your transfer's destination location.
", "smithy.api#required": {} } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor and log events in the task.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
" } }, "Name": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The name of a task. This value is a text reference that is used to identify the task in\n the console.
" + "smithy.api#documentation": "Specifies the name of your task.
" } }, "Options": { "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "Specifies the configuration options for a task. Some options include preserving file or\n object metadata and verifying data integrity.
\nYou can also override these options before starting an individual run of a task (also\n known as a task execution). For more information, see StartTaskExecution.
" + "smithy.api#documentation": "Specifies your task's settings, such as preserving file metadata, verifying data\n integrity, among other options.
" } }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "Specifies a schedule used to periodically transfer files from a source to a destination\n location. The schedule should be specified in UTC time. For more information, see Scheduling your\n task.
" + "smithy.api#documentation": "Specifies a schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "Specifies the tags that you want to apply to the Amazon Resource Name (ARN)\n representing the task.
\n\n Tags are key-value pairs that help you manage, filter, and search\n for your DataSync resources.
" + "smithy.api#documentation": "Specifies the tags that you want to apply to your task.
\n\n Tags are key-value pairs that help you manage, filter, and search\n for your DataSync resources.
" } }, "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies include filters define the files, objects, and folders in your source location\n that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" } }, "ManifestConfig": { @@ -3150,7 +3150,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about an DataSync transfer task.
" + "smithy.api#documentation": "Provides information about a task, which defines where and how DataSync transfers your data.
" } }, "com.amazonaws.datasync#DescribeTaskExecution": { @@ -3331,7 +3331,7 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the transfer task.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the transfer task that you want information\n about.
", "smithy.api#required": {} } } @@ -3347,85 +3347,85 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task that was described.
" + "smithy.api#documentation": "The ARN of your task.
" } }, "Status": { "target": "com.amazonaws.datasync#TaskStatus", "traits": { - "smithy.api#documentation": "The status of the task that was described.
\nFor detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.
" + "smithy.api#documentation": "The status of your task. For information about what each status means, see Task statuses.
" } }, "Name": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The name of the task that was described.
" + "smithy.api#documentation": "The name of your task.
" } }, "CurrentTaskExecutionArn": { "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution that is transferring\n files.
" + "smithy.api#documentation": "The ARN of the most recent task execution.
" } }, "SourceLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source file system's location.
" + "smithy.api#documentation": "The ARN of your transfer's source location.
" } }, "DestinationLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's\n location.
" + "smithy.api#documentation": "The ARN of your transfer's destination location.
" } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.
\nFor more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your\n task.
\nFor more information, see Monitoring DataSync with\n Amazon CloudWatch.
" } }, "SourceNetworkInterfaceArns": { "target": "com.amazonaws.datasync#SourceNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the network interfaces created for your source\n location. For more information, see Network\n interface requirements.
" + "smithy.api#documentation": "The ARNs of the network\n interfaces that DataSync created for your source location.
" } }, "DestinationNetworkInterfaceArns": { "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the network interfaces created for your destination\n location. For more information, see Network\n interface requirements.
" + "smithy.api#documentation": "The ARNs of the network\n interfaces that DataSync created for your destination location.
" } }, "Options": { "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "The configuration options that control the behavior of the\n StartTaskExecution operation. Some options include preserving file or object\n metadata and verifying data integrity.
You can override these options for each task execution. For more information, see\n StartTaskExecution.
" + "smithy.api#documentation": "The task's settings. For example, what file metadata gets preserved, how data integrity\n gets verified at the end of your transfer, bandwidth limits, among other options.
" } }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "A list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "The schedule used to periodically transfer files from a source to a destination\n location.
" + "smithy.api#documentation": "The schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "ErrorCode": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "Errors that DataSync encountered during execution of the task. You can\n use this error code to help troubleshoot issues.
" + "smithy.api#documentation": "If there's an issue with your task, you can use the error code to help you troubleshoot\n the problem. For more information, see Troubleshooting issues with DataSync transfers.
" } }, "ErrorDetail": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.
" + "smithy.api#documentation": "If there's an issue with your task, you can use the error details to help you\n troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
" } }, "CreationTime": { @@ -3437,19 +3437,25 @@ "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "A list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "The include filters that define the files, objects, and folders in your source location\n that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" } }, "ManifestConfig": { "target": "com.amazonaws.datasync#ManifestConfig", "traits": { - "smithy.api#documentation": "The configuration of the manifest that lists the files or objects to transfer. For more\n information, see Specifying what DataSync transfers by using a manifest.
" + "smithy.api#documentation": "The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
" } }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "The configuration of your task report, which provides detailed information about for your\n DataSync transfer. For more information, see Creating a task report.
" + "smithy.api#documentation": "The configuration of your task report, which provides detailed information about your\n DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.
" + } + }, + "ScheduleDetails": { + "target": "com.amazonaws.datasync#TaskScheduleDetails", + "traits": { + "smithy.api#documentation": "The details about your task schedule.
" } } }, @@ -6976,7 +6982,7 @@ "VerifyMode": { "target": "com.amazonaws.datasync#VerifyMode", "traits": { - "smithy.api#documentation": "Specifies how and when DataSync checks the integrity of your data during a\n transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred files and metadata at the source location. At the end of the\n transfer, DataSync then compares this checksum to the checksum calculated on\n those files at the destination.
We recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer,\n DataSync scans the entire source and destination to verify that both locations\n are fully synchronized.
You can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync doesn't run additional verification at the\n end of the transfer. All data transmissions are still integrity-checked with checksum\n verification during the transfer.
Specifies how and when DataSync checks the integrity of your data during a\n transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred files and metadata at the source location. At the end of the\n transfer, DataSync then compares this checksum to the checksum calculated on\n those files at the destination.
We recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer,\n DataSync scans the entire source and destination to verify that both locations\n are fully synchronized.
If you use a manifest, DataSync only scans and\n verifies what's listed in the manifest.
\nYou can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync doesn't run additional verification at the\n end of the transfer. All data transmissions are still integrity-checked with checksum\n verification during the transfer.
Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You\n also can specify how to verify data integrity, set bandwidth limits for your task, among other\n options.
\nEach option has a default value. Unless you need to, you don't have to configure any of\n these options before starting your task.
" + "smithy.api#documentation": "Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You\n also can specify how to verify data integrity, set bandwidth limits for your task, among other\n options.
\nEach option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.
\nYou also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.
The version of the DataSync agent.
\nOn December 7, 2023, we discontinued version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents or delete them if they aren't in use. If you need more help, contact Amazon Web Services Support.
\nThe version of the DataSync agent.
" } } }, @@ -7818,6 +7824,33 @@ "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$" } }, + "com.amazonaws.datasync#ScheduleDisabledBy": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + } + } + }, + "com.amazonaws.datasync#ScheduleDisabledReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": "^[\\w\\s.,'?!:;\\/=|<>()-]*$" + } + }, "com.amazonaws.datasync#ScheduleExpressionCron": { "type": "string", "traits": { @@ -7828,6 +7861,23 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\ \\_\\*\\?\\,\\|\\^\\-\\/\\#\\s\\(\\)\\+]*$" } }, + "com.amazonaws.datasync#ScheduleStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.datasync#SecretsManagerArn": { "type": "string", "traits": { @@ -8350,7 +8400,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$" @@ -8666,13 +8716,45 @@ "ScheduleExpression": { "target": "com.amazonaws.datasync#ScheduleExpressionCron", "traits": { - "smithy.api#documentation": "A cron expression that specifies when DataSync initiates a scheduled\n transfer from a source to a destination location.
", + "smithy.api#documentation": "Specifies your task schedule by using a cron expression in UTC time. For information about\n cron expression syntax, see the \n Amazon EventBridge User\n Guide\n .
", "smithy.api#required": {} } + }, + "Status": { + "target": "com.amazonaws.datasync#ScheduleStatus", + "traits": { + "smithy.api#documentation": "Specifies whether to enable or disable your task schedule. Your schedule is enabled by\n default, but there can be situations where you need to disable it. For example,\n you might need to pause a recurring transfer or fix an issue with your task or perform maintenance on your storage system.
\nDataSync might disable your schedule automatically if your task fails repeatedly\n with the same error. For more information, see TaskScheduleDetails.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures your DataSync task to run on a schedule\n (at a minimum interval of 1 hour).
" + } + }, + "com.amazonaws.datasync#TaskScheduleDetails": { + "type": "structure", + "members": { + "StatusUpdateTime": { + "target": "com.amazonaws.datasync#Time", + "traits": { + "smithy.api#documentation": "Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see\n when the schedule was disabled.
" + } + }, + "DisabledReason": { + "target": "com.amazonaws.datasync#ScheduleDisabledReason", + "traits": { + "smithy.api#documentation": "Provides a reason if the task schedule is disabled.
\nIf your schedule is disabled by USER, you see a Manually disabled by user. message.
If your schedule is disabled by SERVICE, you see an error message to help you\n understand why the task keeps failing. For information on resolving DataSync errors,\n see Troubleshooting issues with DataSync transfers.
Indicates how your task schedule was disabled.
\n\n USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.
\n SERVICE - Your schedule was automatically disabled by DataSync\n because the task failed repeatedly with the same error.
Specifies the schedule you want your task to use for repeated executions. For more\n information, see Schedule Expressions for\n Rules.
" + "smithy.api#documentation": "Provides information about your DataSync\n task schedule.
" } }, "com.amazonaws.datasync#TaskStatus": { @@ -9442,7 +9524,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an DataSync transfer task.
" + "smithy.api#documentation": "Updates the configuration of a task, which defines where and how DataSync transfers your data.
" } }, "com.amazonaws.datasync#UpdateTaskExecution": { @@ -9499,7 +9581,7 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource name of the task to update.
", + "smithy.api#documentation": "Specifies the ARN of the task that you want to update.
", "smithy.api#required": {} } }, @@ -9509,31 +9591,31 @@ "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "Specifies a schedule used to periodically transfer files from a source to a destination\n location. You can configure your task to execute hourly, daily, weekly or on specific days of\n the week. You control when in the day or hour you want the task to execute. The time you\n specify is UTC time. For more information, see Scheduling your task.
" + "smithy.api#documentation": "Specifies a schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "Name": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The name of the task to update.
" + "smithy.api#documentation": "Specifies the name of your task.
" } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log\n group.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
" } }, "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies include filters define the files, objects, and folders in your source location\n that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" } }, "ManifestConfig": { diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 4c15caa0aa4..f24c93652e7 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -35225,6 +35225,14 @@ "smithy.api#documentation": "Indicates whether source/destination checking is enabled.
", "smithy.api#xmlName": "sourceDestCheck" } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
", + "smithy.api#xmlName": "associatePublicIpAddress" + } } }, "traits": { @@ -76377,6 +76385,12 @@ "traits": { "smithy.api#documentation": "A connection tracking specification.
" } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
" + } } }, "traits": { @@ -81304,6 +81318,12 @@ "traits": { "smithy.api#enumValue": "attachment" } + }, + "associatePublicIpAddress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associatePublicIpAddress" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/emr-containers.json b/codegen/sdk-codegen/aws-models/emr-containers.json index dd5671fca8b..a482c697079 100644 --- a/codegen/sdk-codegen/aws-models/emr-containers.json +++ b/codegen/sdk-codegen/aws-models/emr-containers.json @@ -39,6 +39,26 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" } }, + "com.amazonaws.emrcontainers#AuthorizationConfiguration": { + "type": "structure", + "members": { + "lakeFormationConfiguration": { + "target": "com.amazonaws.emrcontainers#LakeFormationConfiguration", + "traits": { + "smithy.api#documentation": "Lake Formation related configuration inputs for the security\n configuration.
" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Encryption-related configuration input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Authorization-related configuration inputs for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#AwsChicagoWebService": { "type": "service", "version": "2020-10-01", @@ -52,6 +72,9 @@ { "target": "com.amazonaws.emrcontainers#CreateManagedEndpoint" }, + { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfiguration" + }, { "target": "com.amazonaws.emrcontainers#CreateVirtualCluster" }, @@ -73,6 +96,9 @@ { "target": "com.amazonaws.emrcontainers#DescribeManagedEndpoint" }, + { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfiguration" + }, { "target": "com.amazonaws.emrcontainers#DescribeVirtualCluster" }, @@ -88,6 +114,9 @@ { "target": "com.amazonaws.emrcontainers#ListManagedEndpoints" }, + { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurations" + }, { "target": "com.amazonaws.emrcontainers#ListTagsForResource" }, @@ -1110,6 +1139,17 @@ "smithy.api#documentation": "The entity representing certificate data generated for managed endpoint.
" } }, + "com.amazonaws.emrcontainers#CertificateProviderType": { + "type": "enum", + "members": { + "PEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PEM" + } + } + } + }, "com.amazonaws.emrcontainers#ClientToken": { "type": "string", "traits": { @@ -1520,6 +1560,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.emrcontainers#CreateSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a security configuration. Security configurations in Amazon EMR on EKS are\n templates for different security setups. You can use security configurations to configure\n the Lake Formation integration setup. You can also create a security configuration\n to re-use a security setup each time you create a virtual cluster.
", + "smithy.api#http": { + "method": "POST", + "uri": "/securityconfigurations", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "The client idempotency token to use when creating the security configuration.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "The name of the security configuration.
", + "smithy.api#required": {} + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "Security configuration input for the request.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "The tags to add to the security configuration.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "The name of the security configuration.
" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the security configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emrcontainers#CreateVirtualCluster": { "type": "operation", "input": { @@ -1581,6 +1708,12 @@ "traits": { "smithy.api#documentation": "The tags assigned to the virtual cluster.
" } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } } }, "traits": { @@ -2012,6 +2145,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.emrcontainers#DescribeSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Displays detailed information about a specified security configuration. Security\n configurations in Amazon EMR on EKS are templates for different security setups. You\n can use security configurations to configure the Lake Formation integration setup.\n You can also create a security configuration to re-use a security setup each time you\n create a virtual cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse": { + "type": "structure", + "members": { + "securityConfiguration": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration", + "traits": { + "smithy.api#documentation": "Details of the security configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emrcontainers#DescribeVirtualCluster": { "type": "operation", "input": { @@ -2097,6 +2288,20 @@ "smithy.api#documentation": "The information about the Amazon EKS cluster.
" } }, + "com.amazonaws.emrcontainers#EncryptionConfiguration": { + "type": "structure", + "members": { + "inTransitEncryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "In-transit encryption-related input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to encryption for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#Endpoint": { "type": "structure", "members": { @@ -2482,6 +2687,20 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" } }, + "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration": { + "type": "structure", + "members": { + "tlsCertificateConfiguration": { + "target": "com.amazonaws.emrcontainers#TLSCertificateConfiguration", + "traits": { + "smithy.api#documentation": "TLS certificate-related configuration input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to in-transit encryption for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#InternalServerException": { "type": "structure", "members": { @@ -2854,6 +3073,32 @@ "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } }, + "com.amazonaws.emrcontainers#LakeFormationConfiguration": { + "type": "structure", + "members": { + "authorizedSessionTagValue": { + "target": "com.amazonaws.emrcontainers#SessionTagValue", + "traits": { + "smithy.api#documentation": "The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.
" + } + }, + "secureNamespaceInfo": { + "target": "com.amazonaws.emrcontainers#SecureNamespaceInfo", + "traits": { + "smithy.api#documentation": "The namespace input of the system job.
" + } + }, + "queryEngineRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The query engine IAM role ARN that is tied to the secure Spark job. The\n QueryEngine role assumes the JobExecutionRole to execute all\n the Lake Formation calls.
Lake Formation related configuration inputs for the security\n configuration.
" + } + }, "com.amazonaws.emrcontainers#ListJobRuns": { "type": "operation", "input": { @@ -3159,6 +3404,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.emrcontainers#ListSecurityConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists security configurations based on a set of parameters. Security configurations in\n Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "securityConfigurations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest": { + "type": "structure", + "members": { + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "The date and time after which the security configuration was created.
", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "The date and time before which the security configuration was created.
", + "smithy.api#httpQuery": "createdBefore" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "The maximum number of security configurations the operation can list.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of security configurations to return.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse": { + "type": "structure", + "members": { + "securityConfigurations": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurations", + "traits": { + "smithy.api#documentation": "The list of returned security configurations.
" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of security configurations to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emrcontainers#ListTagsForResource": { "type": "operation", "input": { @@ -3651,6 +3983,116 @@ "smithy.api#documentation": "Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3.
" } }, + "com.amazonaws.emrcontainers#SecretsManagerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):secretsmanager:.+:(\\d{12}):secret:[0-9a-zA-Z/_+=.@-]+$" + } + }, + "com.amazonaws.emrcontainers#SecureNamespaceInfo": { + "type": "structure", + "members": { + "clusterId": { + "target": "com.amazonaws.emrcontainers#ClusterId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.
" + } + }, + "namespace": { + "target": "com.amazonaws.emrcontainers#KubernetesNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the Amazon EKS cluster where the system jobs run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Namespace inputs for the system job.
" + } + }, + "com.amazonaws.emrcontainers#SecurityConfiguration": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "The name of the security configuration.
" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the security configuration.
" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "The date and time that the job run was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "The user who created the job run.
" + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "Security configuration inputs for the request.
" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Inputs related to the security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.
" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/securityconfigurations\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationData": { + "type": "structure", + "members": { + "authorizationConfiguration": { + "target": "com.amazonaws.emrcontainers#AuthorizationConfiguration", + "traits": { + "smithy.api#documentation": "Authorization-related configuration input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to the security configuration for the request.
" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration" + } + }, "com.amazonaws.emrcontainers#SensitivePropertiesMap": { "type": "map", "key": { @@ -3667,6 +4109,16 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.emrcontainers#SessionTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9 ]+$" + } + }, "com.amazonaws.emrcontainers#SparkSqlJobDriver": { "type": "structure", "members": { @@ -3930,6 +4382,32 @@ "target": "com.amazonaws.emrcontainers#String256" } }, + "com.amazonaws.emrcontainers#TLSCertificateConfiguration": { + "type": "structure", + "members": { + "certificateProviderType": { + "target": "com.amazonaws.emrcontainers#CertificateProviderType", + "traits": { + "smithy.api#documentation": "The TLS certificate type. Acceptable values: PEM or\n Custom.
Secrets Manager ARN that contains the public TLS certificate contents, used for\n communication between the user job and the system job.
" + } + }, + "privateCertificateSecretArn": { + "target": "com.amazonaws.emrcontainers#SecretsManagerArn", + "traits": { + "smithy.api#documentation": "Secrets Manager ARN that contains the private TLS certificate contents, used for\n communication between the user job and the system job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to the TLS certificate for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#TagKeyList": { "type": "list", "member": { @@ -4238,6 +4716,12 @@ "traits": { "smithy.api#documentation": "The assigned tags of the virtual cluster.
" } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/entityresolution.json b/codegen/sdk-codegen/aws-models/entityresolution.json index c7317cb8031..e72464b596e 100644 --- a/codegen/sdk-codegen/aws-models/entityresolution.json +++ b/codegen/sdk-codegen/aws-models/entityresolution.json @@ -8,6 +8,9 @@ { "target": "com.amazonaws.entityresolution#AddPolicyStatement" }, + { + "target": "com.amazonaws.entityresolution#BatchDeleteUniqueId" + }, { "target": "com.amazonaws.entityresolution#CreateIdMappingWorkflow" }, @@ -976,6 +979,102 @@ "target": "com.amazonaws.entityresolution#AwsAccountId" } }, + "com.amazonaws.entityresolution#BatchDeleteUniqueId": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#BatchDeleteUniqueIdInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#BatchDeleteUniqueIdOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes multiple unique IDs in a matching workflow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/matchingworkflows/{workflowName}/uniqueids" + } + } + }, + "com.amazonaws.entityresolution#BatchDeleteUniqueIdInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "inputSource": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The input source for the batch delete unique ID operation.
", + "smithy.api#httpHeader": "inputSource", + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$" + } + }, + "uniqueIds": { + "target": "com.amazonaws.entityresolution#UniqueIdList", + "traits": { + "smithy.api#documentation": "The unique IDs to delete.
", + "smithy.api#httpHeader": "uniqueIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#BatchDeleteUniqueIdOutput": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdStatus", + "traits": { + "smithy.api#documentation": "The status of the batch delete unique ID operation.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdErrorsList", + "traits": { + "smithy.api#documentation": "The errors from deleting multiple unique IDs.
", + "smithy.api#required": {} + } + }, + "deleted": { + "target": "com.amazonaws.entityresolution#DeletedUniqueIdList", + "traits": { + "smithy.api#documentation": "The unique IDs that were deleted.
", + "smithy.api#required": {} + } + }, + "disconnectedUniqueIds": { + "target": "com.amazonaws.entityresolution#DisconnectedUniqueIdsList", + "traits": { + "smithy.api#documentation": "The unique IDs that were disconnected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.entityresolution#ConflictException": { "type": "structure", "members": { @@ -1915,6 +2014,89 @@ "smithy.api#output": {} } }, + "com.amazonaws.entityresolution#DeleteUniqueIdError": { + "type": "structure", + "members": { + "uniqueId": { + "target": "com.amazonaws.entityresolution#UniqueId", + "traits": { + "smithy.api#documentation": "The unique ID that could not be deleted.
", + "smithy.api#required": {} + } + }, + "errorType": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdErrorType", + "traits": { + "smithy.api#documentation": "The error type for the batch delete unique ID operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Delete Unique Id error.
" + } + }, + "com.amazonaws.entityresolution#DeleteUniqueIdErrorType": { + "type": "enum", + "members": { + "SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_ERROR" + } + }, + "VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_ERROR" + } + } + } + }, + "com.amazonaws.entityresolution#DeleteUniqueIdErrorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdError" + } + }, + "com.amazonaws.entityresolution#DeleteUniqueIdStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "ACCEPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPTED" + } + } + } + }, + "com.amazonaws.entityresolution#DeletedUniqueId": { + "type": "structure", + "members": { + "uniqueId": { + "target": "com.amazonaws.entityresolution#UniqueId", + "traits": { + "smithy.api#documentation": "The unique ID of the deleted item.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The deleted unique ID.
" + } + }, + "com.amazonaws.entityresolution#DeletedUniqueIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#DeletedUniqueId" + } + }, "com.amazonaws.entityresolution#Description": { "type": "string", "traits": { @@ -1923,6 +2105,12 @@ } } }, + "com.amazonaws.entityresolution#DisconnectedUniqueIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#UniqueId" + } + }, "com.amazonaws.entityresolution#EntityName": { "type": "string", "traits": { @@ -4861,7 +5049,7 @@ "smithy.api#length": { "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z_0-9-.@ ()+\\t]*$" + "smithy.api#pattern": "^[a-zA-Z_0-9-./@ ()+\\t]*$" } }, "traits": { @@ -4986,7 +5174,7 @@ "smithy.api#documentation": "A list of Rule objects, each of which have fields RuleName and\n MatchingKeys.
Amazon GameLift Anywhere configuration options for your Anywhere fleets.
" + "smithy.api#documentation": "Amazon GameLift configuration options for your Anywhere fleets.
" } }, "com.amazonaws.gamelift#ArnStringModel": { @@ -454,7 +454,7 @@ } }, "traits": { - "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.
\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDetermines 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.
A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is an instance\n ID.
" + "smithy.api#documentation": "A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the InstanceId\n ID.
The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are\n unique across locations. Instances in managed EC2 fleets are not assigned a\n ComputeARN.
" + "smithy.api#documentation": "The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are\n unique across locations. Instances in managed EC2 fleets are not assigned a Compute\n ARN.
" } }, "IpAddress": { @@ -671,108 +671,986 @@ "traits": { "smithy.api#documentation": "The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere\n fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift\n service.
" } + }, + "GameLiftAgentEndpoint": { + "target": "com.amazonaws.gamelift#GameLiftAgentEndpointOutput", + "traits": { + "smithy.api#documentation": "The endpoint of the Amazon GameLift Agent.
" + } + }, + "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
\n Some attributes of a container.\n
" + } + } + }, + "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
\nAn 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:
\nFor EC2 fleets, a compute is an EC2 instance.
For ANYWHERE fleets, a compute is a computing resource that you\n provide and is registered to the fleet.
For CONTAINER fleets, a compute is a container that's registered\n to the fleet.
The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.
\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.gamelift#ConnectionPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Starting value for the port range.
", + "smithy.api#required": {} + } + }, + "ToPort": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Ending value for the port. Port numbers are end-inclusive. This value must be equal to\n or greater than FromPort.
\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe 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
\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDescribes attributes of containers that are deployed to a fleet with compute type\n CONTAINER.
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.
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.
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
\nDescribes 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
" + } + }, + "com.amazonaws.gamelift#ContainerDefinitionInput": { + "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:
\nImage ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository\n ID]\n
Image ID and digest: [AWS account].dkr.ecr.[AWS\n region].amazonaws.com/[repository ID]@[digest]\n
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository\n ID]:[tag]\n
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.
\nContainer 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.
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:
\nChoose a container is running your game server and the Amazon GameLift Agent.
\nInclude a port configuration. This container runs your game server processes, and each\n process requires a container port to allow access to game clients.
\nDon't configure a health check. The Agent handles this task for the essential replica\n container.
\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.
" + } + }, + "DependsOn": { + "target": "com.amazonaws.gamelift#ContainerDependencyList", + "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.
\nYou can use dependencies\n to establish a startup/shutdown sequence across the container group. A container startup\n dependency is reversed on shutdown.
\nFor 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.
\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDescribes 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
" + } + }, + "com.amazonaws.gamelift#ContainerDefinitionInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerDefinitionInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ContainerDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ContainerDependency": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A descriptive label for the container definition that this container depends on.
", + "smithy.api#required": {} + } + }, + "Condition": { + "target": "com.amazonaws.gamelift#ContainerDependencyCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The condition that the dependency container must reach before the dependent container can\n start. Valid conditions include:
\nSTART - The dependency container must have started.
\nCOMPLETE - The dependency container has run to completion (exits). Use this condition with\n nonessential containers, such as those that run a script and then exit. The dependency\n container can't be an essential container.
\nSUCCESS - The dependency container has run to completion and exited with a zero status. The\n dependency container can't be an essential container.
\nHEALTHY - The dependency container has passed its Docker health check. Use this condition with\n dependency containers that have health checks configured. This condition is confirmed at\n container group startup only.
\n\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nA 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.
\nFor 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 Part of:\n ContainerDefinition\n
" + } + }, + "com.amazonaws.gamelift#ContainerDependencyCondition": { + "type": "enum", + "members": { + "START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + } + } + }, + "com.amazonaws.gamelift#ContainerDependencyList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerDependency" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "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": { + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The environment variable name.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The environment variable value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nAn 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
" + } + }, + "com.amazonaws.gamelift#ContainerEnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerEnvironment" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinition": { + "type": "structure", + "members": { + "ContainerGroupDefinitionArn": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionArn", + "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:.
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
The platform required for all containers in the container group definition.
" + } + }, + "Name": { + "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.
" + } + }, + "SchedulingStrategy": { + "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "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.
" + } + }, + "TotalMemoryLimit": { + "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.
\nYou can set additional limits for each ContainerDefinition in\n the group. If individual containers have limits, this value must meet the following\n requirements:
\nEqual to or greater than the sum of all container-specific soft memory limits in the group.
\nEqual to or greater than any container-specific hard limits in the group.
\nFor more details on memory allocation, see the Container fleet design\n guide.
" + } + }, + "TotalCpuLimit": { + "target": "com.amazonaws.gamelift#ContainerTotalCpuLimit", + "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).
\nYou 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.
\nFor more details on memory allocation, see the Container fleet design\n guide.
" + } + }, + "ContainerDefinitions": { + "target": "com.amazonaws.gamelift#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "\n The set of container definitions that are included in the container group.\n
" + } + }, + "Status": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionStatus", + "traits": { + "smithy.api#documentation": "Current status of the container group definition resource. Values include:
\n\n COPYING -- Amazon GameLift is in the process of making copies of all container\n images that are defined in the group. While in this state, the resource can't be used to\n create a container fleet.
\n READY -- Amazon GameLift has copied the registry images for all containers that\n are defined in the group. You can use a container group definition in this status to\n create a container fleet.
\n FAILED -- Amazon GameLift failed to create a valid container group definition\n resource. For more details on the cause of the failure, see StatusReason. A\n container group definition resource in failed status will be deleted within a few\n minutes.
Additional information about a container group definition that's in FAILED\n status. Possible reasons include:
An internal issue prevented Amazon GameLift from creating\n the container group definition resource. Delete the failed resource and call \n CreateContainerGroupDefinitionagain.
\nAn access-denied message means that you don't have permissions to access the container image on ECR. See \n \n IAM permission examples\n for help setting up required IAM permissions for Amazon GameLift.
\nThe ImageUri value for at least one\n of the containers in the container group definition was invalid or not found in the current\n Amazon Web Services account.
At least one\n of the container images referenced in the container group definition exceeds the \n allowed size. For size limits, see \n Amazon GameLift endpoints and quotas.
\nAt least one of the container images referenced in the \n container group definition uses a different operating system than the one defined for the container group.
\n\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe 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
" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:.*:containergroupdefinition\\/containergroupdefinition-[a-zA-Z0-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\\-]+$" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArnLimitedList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionProperty" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionProperty": { + "type": "structure", + "members": { + "SchedulingStrategy": { + "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "traits": { + "smithy.api#documentation": "The method for scheduling and maintaining copies of the container group across a container\n fleet.
" + } + }, + "ContainerGroupDefinitionName": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionName", + "traits": { + "smithy.api#documentation": "The unique identifier for the container group definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe 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
" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "COPYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPYING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.gamelift#ContainerGroupsAttributes": { + "type": "structure", + "members": { + "ContainerGroupDefinitionProperties": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionPropertiesList", + "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.
" + } + }, + "ConnectionPortRange": { + "target": "com.amazonaws.gamelift#ConnectionPortRange", + "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.
Details about the number of replica container groups that Amazon GameLift deploys to each instance in\n the container fleet.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe 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
" + } + }, + "com.amazonaws.gamelift#ContainerGroupsConfiguration": { + "type": "structure", + "members": { + "ContainerGroupDefinitionNames": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArnLimitedList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of container group definition names to deploy to a new container fleet.
", + "smithy.api#required": {} + } + }, + "ConnectionPortRange": { + "target": "com.amazonaws.gamelift#ConnectionPortRange", + "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.
\nConnection 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
\nAs a best practice, double the minimum number of connection ports.
\nUse 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.
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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nConfiguration details for a set of container groups, for use when creating a fleet with\n compute type CONTAINER.
\n Used with:\n CreateFleet\n
" + } + }, + "com.amazonaws.gamelift#ContainerGroupsPerInstance": { + "type": "structure", + "members": { + "DesiredReplicaContainerGroupsPerInstance": { + "target": "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance", + "traits": { + "smithy.api#documentation": "The desired number of replica container groups to place on each fleet instance.
" + } + }, + "MaxReplicaContainerGroupsPerInstance": { + "target": "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance", + "traits": { + "smithy.api#documentation": "The maximum possible number of replica container groups that each fleet instance can\n have.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDetermines how many replica container groups that Amazon GameLift deploys to each instance in a\n container fleet.
\nAmazon 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:
\nIf no desired value is set, Amazon GameLift places the calculated maximum.
\nIf a desired number is set to a value higher than the calculated maximum, Amazon GameLift\n places the calculated maximum.
\nIf a desired number is set to a value lower than the calculated maximum, Amazon GameLift\n places the desired number.
\n\n Part of:\n ContainerGroupsConfiguration, ContainerGroupsAttributes\n
\n\n Returned by:\n DescribeFleetAttributes, CreateFleet\n
" + } + }, + "com.amazonaws.gamelift#ContainerHealthCheck": { + "type": "structure", + "members": { + "Command": { + "target": "com.amazonaws.gamelift#ContainerCommandStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A string array that specifies the command that the container runs to determine if it's\n healthy.
", + "smithy.api#required": {} + } + }, + "Interval": { + "target": "com.amazonaws.gamelift#ContainerHealthCheckInterval", + "traits": { + "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.
" + } + }, + "StartPeriod": { + "target": "com.amazonaws.gamelift#ContainerHealthCheckStartPeriod", + "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.
" + } + } + }, + "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.
\nThe 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 Part of:\n ContainerDefinition$HealthCheck\n
" + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 300 + } + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckRetries": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckStartPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 300 + } + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30, + "max": 60 + } + } + }, + "com.amazonaws.gamelift#ContainerMemoryLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 4, + "max": 1024000 + } + } + }, + "com.amazonaws.gamelift#ContainerMemoryLimits": { + "type": "structure", + "members": { + "SoftLimit": { + "target": "com.amazonaws.gamelift#ContainerMemoryLimit", + "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).
" + } + }, + "HardLimit": { + "target": "com.amazonaws.gamelift#ContainerMemoryLimit", + "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
" + } + } + }, + "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
" + } + }, + "com.amazonaws.gamelift#ContainerOperatingSystem": { + "type": "enum", + "members": { + "AMAZON_LINUX_2023": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX_2023" + } } - }, - "traits": { - "smithy.api#documentation": "An Amazon GameLift compute resource for hosting your game servers. A compute can be an\n EC2instance in a managed EC2 fleet or a registered compute in an Anywhere fleet.
" } }, - "com.amazonaws.gamelift#ComputeArn": { - "type": "string", + "com.amazonaws.gamelift#ContainerPortConfiguration": { + "type": "structure", + "members": { + "ContainerPortRanges": { + "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#required": {} + } + } + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:.*:compute\\/[a-zA-Z0-9\\-]+$" + "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#ComputeAuthToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "com.amazonaws.gamelift#ContainerPortMapping": { + "type": "structure", + "members": { + "ContainerPort": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#documentation": "The port opened on the container.
" + } }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + "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 Part of:\n ContainerAttributes\n
" } }, - "com.amazonaws.gamelift#ComputeList": { + "com.amazonaws.gamelift#ContainerPortMappingList": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#Compute" - } - }, - "com.amazonaws.gamelift#ComputeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" - } - }, - "com.amazonaws.gamelift#ComputeNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+|^arn:.*:compute\\/[a-zA-Z0-9\\-]+$" + "target": "com.amazonaws.gamelift#ContainerPortMapping" } }, - "com.amazonaws.gamelift#ComputeStatus": { - "type": "enum", + "com.amazonaws.gamelift#ContainerPortRange": { + "type": "structure", "members": { - "PENDING": { - "target": "smithy.api#Unit", + "FromPort": { + "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#enumValue": "PENDING" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A starting value for the range of allowed port numbers.
", + "smithy.api#required": {} } }, - "ACTIVE": { - "target": "smithy.api#Unit", + "ToPort": { + "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#enumValue": "ACTIVE" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An ending value for the range of allowed port numbers.\n Port numbers are end-inclusive.\n This value must be equal to or greater than FromPort.
The network protocol that these ports support.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nA 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#ComputeType": { + "com.amazonaws.gamelift#ContainerPortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerPortRange" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.gamelift#ContainerSchedulingStrategy": { "type": "enum", "members": { - "EC2": { + "REPLICA": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EC2" + "smithy.api#enumValue": "REPLICA" } }, - "ANYWHERE": { + "DAEMON": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ANYWHERE" + "smithy.api#enumValue": "DAEMON" } } } }, - "com.amazonaws.gamelift#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.gamelift#NonEmptyString" + "com.amazonaws.gamelift#ContainerTotalCpuLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128, + "max": 10240 } - }, + } + }, + "com.amazonaws.gamelift#ContainerTotalMemoryLimit": { + "type": "integer", "traits": { - "smithy.api#documentation": "The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.
\n ", - "smithy.api#error": "client" + "smithy.api#range": { + "min": 4, + "max": 1024000 + } } }, "com.amazonaws.gamelift#CreateAlias": { @@ -956,6 +1834,115 @@ "smithy.api#output": {} } }, + "com.amazonaws.gamelift#CreateContainerGroupDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#CreateContainerGroupDefinitionInput" + }, + "output": { + "target": "com.amazonaws.gamelift#CreateContainerGroupDefinitionOutput" + }, + "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": "\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nCreates 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.
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.
\nYou can create two types of container groups, based on scheduling strategy:
\nA replica container group manages the containers that run\n your game server application and supporting software. Replica container groups might be\n replicated multiple times on each fleet instance, depending on instance resources.
\nA daemon container group manages containers that run other\n software, such as background services, logging, or test processes. You might use a daemon\n container group for processes that need to run only once per fleet instance, or processes\n that need to persist independently of the replica container group.
\nTo 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.
\nThis 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.
\nIf 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 Learn more\n
\nA descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "SchedulingStrategy": { + "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "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.
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#required": {} + } + }, + "TotalCpuLimit": { + "target": "com.amazonaws.gamelift#ContainerTotalCpuLimit", + "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#required": {} + } + }, + "ContainerDefinitions": { + "target": "com.amazonaws.gamelift#ContainerDefinitionInputList", + "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": {} + } + }, + "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.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.gamelift#TagList", + "traits": { + "smithy.api#documentation": "A list of labels to assign to the container group definition resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management,\n access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#CreateContainerGroupDefinitionOutput": { + "type": "structure", + "members": { + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#CreateFleet": { "type": "operation", "input": { @@ -980,6 +1967,9 @@ { "target": "com.amazonaws.gamelift#NotFoundException" }, + { + "target": "com.amazonaws.gamelift#NotReadyException" + }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, @@ -991,7 +1981,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or\n Realtime Servers. Use this operation to configure the computing resources for your fleet and\n provide instructions for running game servers on each instance.
\nMost Amazon GameLift fleets can deploy instances to multiple locations, including the home\n Region (where the fleet is created) and an optional set of remote locations. Fleets that\n are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N.\n Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),\n ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that\n are created in other Amazon GameLift Regions can deploy instances in the fleet's home Region\n only. All fleet instances use the same configuration regardless of location; however,\n you can adjust capacity settings and turn auto-scaling on/off for each location.
\nTo create a fleet, choose the hardware for your instances, specify a game server build\n or Realtime script to deploy, and provide a runtime configuration to direct Amazon GameLift how\n to start and run game servers on each instance in the fleet. Set permissions for inbound\n traffic to your game servers, and enable optional features as needed. When creating a\n multi-location fleet, provide a list of additional remote locations.
\nIf you need to debug your fleet, fetch logs, view performance metrics or other actions\n on the fleet, create the development fleet with port 22/3389 open. As a best practice,\n we recommend opening ports for remote access only when you need them and closing them\n when you're finished.
\nIf successful, this operation creates a new Fleet resource and places it in\n NEW status, which prompts Amazon GameLift to initiate the fleet creation\n workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events\n using DescribeFleetEvents.
When the fleet status changes to ACTIVE, you can enable automatic scaling\n with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches\n ACTIVE, you can set capacity by location using UpdateFleetCapacity.
\n Learn more\n
\n\n Setting up\n fleets\n
\n\n Debug fleet creation issues\n
\n " + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nCreates 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
\nAn 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.
To create an EC2 fleet, provide these required parameters:
\nEither BuildId or ScriptId\n
\n ComputeType set to EC2 (the default value)
\n EC2InboundPermissions\n
\n EC2InstanceType\n
\n FleetType\n
\n Name\n
\n RuntimeConfiguration with at least one ServerProcesses\n configuration
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.
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
\nA 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.
To create a container fleet, provide these required parameters:
\n\n ComputeType set to CONTAINER\n
\n ContainerGroupsConfiguration\n
\n EC2InboundPermissions\n
\n EC2InstanceType\n
\n FleetType set to ON_DEMAND\n
\n Name\n
\n RuntimeConfiguration with at least one ServerProcesses\n configuration
If successful, this operation creates a new fleet resource and places it in\n NEW status while Amazon GameLift initiates the fleet creation workflow.
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
\nAn 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.
\nTo create an Anywhere fleet, provide these required parameters:
\n\n ComputeType set to ANYWHERE\n
\n Locations specifying a custom location
\n Name\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 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 " } }, "com.amazonaws.gamelift#CreateFleetInput": { @@ -1014,13 +2004,13 @@ "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for a custom game server build to be deployed on fleet\n instances. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift\n and in READY status. This fleet property can't be changed after the fleet is created.
The unique identifier for a custom game server build to be deployed to a fleet with\n compute type EC2. You can use either the build ID or ARN. The build must be\n uploaded to Amazon GameLift and in READY status. This fleet property can't be changed after the fleet is created.
The unique identifier for a Realtime configuration script to be deployed on fleet\n instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift\n prior to creating the fleet. This fleet property can't be changed after the fleet is created.
" + "smithy.api#documentation": "The unique identifier for a Realtime configuration script to be deployed to a fleet with\n compute type EC2. You can use either the script ID or ARN. Scripts must be\n uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.
The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance\n type determines the computing resources that will be used to host your game servers,\n including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions\n of Amazon EC2 instance types.
" + "smithy.api#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.
" } }, "EC2InboundPermissions": { "target": "com.amazonaws.gamelift#IpPermissionsList", "traits": { - "smithy.api#documentation": "The allowed IP address ranges and port settings that allow inbound traffic to access\n game sessions on this fleet. If the fleet is hosting a custom game build, this property\n must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift\n automatically sets TCP and UDP ranges.
" + "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.
\nTo 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.
" } }, "NewGameSessionProtectionPolicy": { @@ -1062,7 +2052,7 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "Instructions for how to launch and maintain server processes on instances in the\n fleet. The runtime configuration defines one or more server process configurations, each\n identifying a build executable or Realtime script file and the number of processes of\n that type to run concurrently.
\nThe RuntimeConfiguration parameter is required unless the fleet is\n being configured using the older parameters ServerLaunchPath and\n ServerLaunchParameters, which are still supported for backward\n compatibility.
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.
\nThis parameter replaces the parameters ServerLaunchPath and\n ServerLaunchParameters, which are still supported for backward\n compatibility.
A set of remote locations to deploy additional instances to and manage as part of the\n fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that\n support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote\n location, in the form of an Amazon Web Services Region code such as us-west-2. To create\n a fleet with instances in the home Region only, don't use this parameter.
To use this parameter, Amazon GameLift requires you to use your home location in the\n request.
" + "smithy.api#documentation": "A set of remote locations to deploy additional instances to and manage as part of the\n fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that\n support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote\n location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local\n Zone code. To create a fleet with instances in the home Region only, don't set this\n parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the\n request.
" } }, "Tags": { @@ -1122,7 +2112,7 @@ "ComputeType": { "target": "com.amazonaws.gamelift#ComputeType", "traits": { - "smithy.api#documentation": "The type of compute resource used to host your game servers. You can use your own\n compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed\n Amazon GameLift. By default, this property is set to EC2.
The type of compute resource used to host your game servers.
\n\n EC2 – The game server build is deployed to Amazon EC2 instances for\n cloud hosting. This is the default setting.
\n CONTAINER – Container images with your game server build and\n supporting software are deployed to Amazon EC2 instances for cloud hosting. With this\n compute type, you must specify the ContainerGroupsConfiguration\n parameter.
\n ANYWHERE – Game servers or container images with your game server\n and supporting software are deployed to compute resources that are provided and\n managed by you. With this compute type, you can also set the\n AnywhereConfiguration parameter.
Prompts Amazon GameLift to generate a shared credentials file for the IAM role\n defined in InstanceRoleArn. The shared credentials file is stored on each\n fleet instance and refreshed as needed. Use shared credentials for applications that are\n deployed along with the game server executable, if the game server is integrated with \n 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.
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.
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.
" } } }, @@ -1169,6 +2165,9 @@ { "target": "com.amazonaws.gamelift#NotFoundException" }, + { + "target": "com.amazonaws.gamelift#NotReadyException" + }, { "target": "com.amazonaws.gamelift#UnauthorizedException" }, @@ -1177,7 +2176,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds remote locations to a fleet and begins populating the new locations with EC2\n instances. The new instances conform to the fleet's instance type, auto-scaling, and\n other configuration settings.
\nThis operation cannot be used with fleets that don't support remote locations.\n Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support\n this feature and were created after the feature was released in March 2021.
\nTo add fleet locations, specify the fleet to be updated and provide a list of one or\n more locations.
\nIf 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 Learn more\n
\n\n Setting up\n fleets\n
\n " + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nAdds 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.
\nYou 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.
\nTo add fleet locations, specify the fleet to be updated and provide a list of one or\n more locations.
\nIf 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 Learn more\n
\n\n Setting up\n fleets\n
\n " } }, "com.amazonaws.gamelift#CreateFleetLocationsInput": { @@ -2386,14 +3385,62 @@ "smithy.api#documentation": "Deletes a build. This operation permanently deletes the build resource and any\n uploaded build files. Deleting a build does not affect the status of any active fleets\n using the build, but you can no longer create new fleets with the deleted build.
\nTo delete a build, specify the build ID.
\n\n Learn more\n
\n\n Upload a Custom\n Server Build\n
\n\n All APIs by task\n
" } }, - "com.amazonaws.gamelift#DeleteBuildInput": { + "com.amazonaws.gamelift#DeleteBuildInput": { + "type": "structure", + "members": { + "BuildId": { + "target": "com.amazonaws.gamelift#BuildIdOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier for the build to delete. You can use either the build ID or ARN value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#DeleteContainerGroupDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DeleteContainerGroupDefinitionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "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": "\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nDeletes a container group definition resource. You can delete a container group definition\n if there are no fleets using the definition.
\nTo delete a container group definition, identify the resource to delete.
\n\n Learn more\n
\nA unique identifier for the build to delete. You can use either the build ID or ARN value.
", + "smithy.api#documentation": "The unique identifier for the container group definition to delete. You can use either the Name or ARN\n value.
Deletes all resources and information related a fleet. Any current fleet instances,\n including those in remote locations, are shut down. You don't need to call\n DeleteFleetLocations separately.
If the fleet being deleted has a VPC peering connection, you first need to get a\n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the\n VPC peering connection.
\nTo delete a fleet, specify the fleet ID to be terminated. During the deletion process\n the fleet status is changed to DELETING. When completed, the status\n switches to TERMINATED and the fleet event FLEET_DELETED is\n sent.
\n Learn more\n
\n\n Setting up Amazon GameLift\n Fleets\n
" + "smithy.api#documentation": "Deletes all resources and information related to a fleet and shuts down any currently\n running fleet instances, including those in remote locations.
\nIf the fleet being deleted has a VPC peering connection, you first need to get a\n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the\n VPC peering connection.
\nTo delete a fleet, specify the fleet ID to be terminated. During the deletion process,\n the fleet status is changed to DELETING. When completed, the status\n switches to TERMINATED and the fleet event FLEET_DELETED is\n emitted.
\n Learn more\n
\n\n Setting up Amazon GameLift\n Fleets\n
" } }, "com.amazonaws.gamelift#DeleteFleetInput": { @@ -3028,7 +4075,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes a compute resource from an Amazon GameLift Anywhere fleet. Deregistered computes can no\n longer host game sessions through Amazon GameLift.
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRemoves a compute resource from an Amazon GameLift Anywhere fleet or container fleet.\n Deregistered computes can no longer host game sessions through Amazon GameLift.
\nFor 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.
\nTo 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": { @@ -3046,7 +4093,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the compute resource to remove from the specified Anywhere fleet.
", + "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.
Retrieves properties for a compute resource in an Amazon GameLift fleet. Call ListCompute to get a list of compute resources in a fleet. You can\n request information for computes in either managed EC2 fleets or Anywhere fleets.
\nTo request compute properties, specify the compute name and fleet ID.
\nIf successful, this operation returns details for the requested compute resource. For\n managed EC2 fleets, this operation returns the fleet's EC2 instances. For Anywhere\n fleets, this operation returns the fleet's registered computes.
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all\n computes in a fleet, call ListCompute.
\nTo request information on a specific compute, provide the fleet ID and compute\n name.
\nIf successful, this operation returns details for the requested compute resource.\n Depending on the fleet's compute type, the result includes the following information:
\nFor EC2 fleets, this operation returns information about the EC2\n instance.
For ANYWHERE fleets, this operation returns information about the\n registered compute.
For CONTAINER fleets, this operation returns information about\n the container that's registered as a compute, and the instance it's running on.\n The compute name is the container name.
A unique identifier for the fleet that the compute is registered to. You can use either the fleet ID or ARN\n value.
", + "smithy.api#documentation": "A unique identifier for the fleet that the compute belongs to. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, @@ -3265,7 +4312,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 a managed EC2 fleet\n instance, use the instance ID.
", + "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.
\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nRetrieves the properties of a container group definition, including all container\n definitions in the group.
\nTo 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
\nThe unique identifier for the container group definition to retrieve properties for. You can use either the Name or\n ARN value.
The properties of the requested container group definition resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#DescribeEC2InstanceLimits": { "type": "operation", "input": { @@ -3371,7 +4477,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves core fleet-wide properties, including the computing hardware and deployment\n configuration for all instances in the fleet.
\nThis operation can be used in the following ways:
\nTo get attributes for one or more specific fleets, provide a list of fleet IDs\n or fleet ARNs.
\nTo get attributes for all fleets, do not provide a fleet identifier.
\nWhen requesting attributes for multiple fleets, use the pagination parameters to\n retrieve results as a set of sequential pages.
\nIf successful, a FleetAttributes object is returned for each fleet\n requested, unless the fleet identifier is not found.
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 Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves 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.
\nYou can use this operation in the following ways:
\nTo get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
\nTo get attributes for all fleets, do not provide a fleet identifier.
\nWhen requesting attributes for multiple fleets, use the pagination parameters to\n retrieve results as a set of sequential pages.
\nIf successful, a FleetAttributes object is returned for each fleet\n requested, unless the fleet identifier is not found.
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 Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3449,7 +4555,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the resource capacity settings for one or more fleets. The data returned\n includes the current fleet capacity (number of EC2 instances), and settings that can\n control how capacity scaling. For fleets with remote locations, this operation retrieves\n data for the fleet's home Region only.
\nThis operation can be used in the following ways:
\nTo get capacity data for one or more specific fleets, provide a list of fleet\n IDs or fleet ARNs.
\nTo get capacity data for all fleets, do not provide a fleet identifier.\n
\nWhen requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.
\nIf successful, a FleetCapacity object is returned for each requested\n fleet ID. Each FleetCapacity object includes a Location property, which is\n set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects\n are returned only for fleets that currently exist.
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 Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n GameLift metrics for fleets\n
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves the resource capacity settings for one or more fleets. For a container\n fleet, this operation also returns counts for replica container groups.
\nWith multi-location fleets, this operation retrieves data for the fleet's home Region\n only. To retrieve capacity for remote locations, see \n DescribeFleetLocationCapacity.
\nThis operation can be used in the following ways:
\nTo get capacity data for one or more specific fleets, provide a list of fleet\n IDs or fleet ARNs.
\nTo get capacity data for all fleets, do not provide a fleet identifier.\n
\nWhen requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.
\nIf 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.
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 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", @@ -3722,7 +4828,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the resource capacity settings for a fleet location. The data returned\n includes the current capacity (number of EC2 instances) and some scaling settings for\n the requested fleet location. Use this operation to retrieve capacity information for a\n fleet's remote location or home Region (you can also retrieve home Region capacity by\n calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
\nIf successful, a FleetCapacity object is returned for the requested fleet\n location.
\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 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.
\nUse 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).
To retrieve capacity data, identify a fleet and location.
\nIf successful, a FleetCapacity object is returned for the requested fleet\n location.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n GameLift metrics for fleets\n
" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacityInput": { @@ -3856,7 +4962,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a fleet's inbound connection permissions. Connection permissions specify the\n range of IP addresses and port settings that incoming traffic can use to access server\n processes in the fleet. Game sessions that are running on instances in the fleet must\n use connections that fall in this range.
\nThis operation can be used in the following ways:
\nTo retrieve the inbound connection permissions for a fleet, identify the\n fleet's unique identifier.
\nTo check the status of recent updates to a fleet remote location, specify the\n fleet ID and a location. Port setting updates can take time to propagate across\n all locations.
\nIf successful, a set of IpPermission objects is returned for the\n requested fleet ID. When a location is specified, a pending status is included. If the\n requested fleet has been deleted, the result set is empty.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" + "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.
\nUse this operation in the following ways:
\nTo retrieve the port settings for a fleet, identify the fleet's unique\n identifier.
\nTo check the status of recent updates to a fleet remote location, specify the\n fleet ID and a location. Port setting updates can take time to propagate across\n all locations.
\nIf 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 Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsInput": { @@ -4981,7 +6087,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a fleet's runtime configuration settings. The runtime configuration tells\n Amazon GameLift which server processes to run (and how) on each instance in the fleet.
\nTo get the runtime configuration that is currently in forces for a fleet, provide the\n fleet ID.
\nIf 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 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, 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.
\nTo get the current runtime configuration for a fleet, provide the fleet ID.
\nIf 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 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": { @@ -5006,7 +6112,7 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "Instructions that describe how server processes should be launched and maintained on\n each instance in the fleet.
" + "smithy.api#documentation": "Instructions that describe how server processes are launched and maintained on\n computes in the fleet.
" } } }, @@ -6489,6 +7595,12 @@ "traits": { "smithy.api#documentation": "Location of stored logs with additional detail that is related to the event. This is\n useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet\n creation logs through the Amazon GameLift console.
" } + }, + "Count": { + "target": "com.amazonaws.gamelift#EventCount", + "traits": { + "smithy.api#documentation": "The number of times that this event occurred.
" + } } }, "traits": { @@ -6704,6 +7816,15 @@ } } }, + "com.amazonaws.gamelift#EventCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 101 + } + } + }, "com.amazonaws.gamelift#EventList": { "type": "list", "member": { @@ -6794,13 +7915,13 @@ "FleetType": { "target": "com.amazonaws.gamelift#FleetType", "traits": { - "smithy.api#documentation": "Indicates whether to use On-Demand or Spot instances for this fleet. By default, this\n property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
Indicates whether the fleet uses On-Demand or Spot instances. For more information,\n see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
" } }, "InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "The Amazon EC2 instance type that determines the computing resources of each instance in\n the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See\n Amazon Elastic Compute Cloud Instance Types\n for detailed descriptions.
" + "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\".
Current status of the fleet. Possible fleet statuses include the following:
\n\n NEW -- A new fleet has been defined and desired\n instances is set to 1.
\n\n DOWNLOADING/VALIDATING/BUILDING/ACTIVATING --\n Amazon GameLift is setting up the new fleet, creating new instances with the game build\n or Realtime script and starting server processes.
\n\n ACTIVE -- Hosts can now accept game\n sessions.
\n\n ERROR -- An error occurred when downloading,\n validating, building, or activating the fleet.
\n\n DELETING -- Hosts are responding to a delete\n fleet request.
\n\n TERMINATED -- The fleet no longer\n exists.
\nCurrent status of the fleet. Possible fleet statuses include the following:
\nNEW -- A new fleet has been defined and desired\n instances is set to 1.
\nDOWNLOADING/VALIDATING/BUILDING/ACTIVATING --\n Amazon GameLift is setting up the new fleet, creating new instances with the game build\n or Realtime script and starting server processes.
\nACTIVE -- Hosts can now accept game sessions.
\nERROR -- An error occurred when downloading,\n validating, building, or activating the fleet.
\nDELETING -- Hosts are responding to a delete fleet request.
\nTERMINATED -- The fleet no longer exists.
\nA unique identifier for the build resource that is deployed on instances in this fleet.
" + "smithy.api#documentation": "A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with\n fleets where ComputeType is \"EC2\".
The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in\n this fleet. In a GameLift build ARN, the resource ID matches the BuildId\n value.
The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in\n this fleet. In a GameLift build ARN, the resource ID matches the BuildId\n value. This attribute is used with fleets where ComputeType is \"EC2\".
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
" + "smithy.api#documentation": "A unique identifier for the Realtime script resource that is deployed on instances in this fleet.\n This attribute is used with fleets where ComputeType is \"EC2\".
\n This parameter is no longer used. Server launch paths\n are now defined using the fleet's\n RuntimeConfiguration\n . Requests that use this parameter instead continue to be valid.
" + "smithy.api#documentation": "\n This parameter is no longer used. Server launch paths\n are now defined using the fleet's\n RuntimeConfiguration\n . Requests that use this parameter continue to be valid.
" } }, "ServerLaunchParameters": { "target": "com.amazonaws.gamelift#LaunchParametersStringModel", "traits": { - "smithy.api#documentation": "\n This parameter is no longer used. Server launch\n parameters are now defined using the fleet's runtime configuration\n . Requests that use this parameter instead continue to be valid.
" + "smithy.api#documentation": "\n This parameter is no longer used. Server launch\n parameters are now defined using the fleet's runtime configuration\n . Requests that use this parameter continue to be valid.
" } }, "LogPaths": { @@ -6878,13 +7999,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.
\n\n NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
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 NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
The operating system of the fleet's computing resources. A fleet's operating system is\n determined by the OS of the build or script that is deployed on this fleet.
" + "smithy.api#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\".
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch,\n you can view aggregated metrics for fleets that are in a metric group. A fleet can be\n included in only one metric group at a time.
" + "smithy.api#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\".
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
" + "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\".
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.
" + "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\".
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. \n All instances in a fleet share the same certificate.
" + } }, "ComputeType": { "target": "com.amazonaws.gamelift#ComputeType", @@ -6918,17 +8042,26 @@ } }, "AnywhereConfiguration": { - "target": "com.amazonaws.gamelift#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\".
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.
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\".
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.
Describes a Amazon GameLift fleet of game hosting resources.
\n\n Related actions\n
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDescribes an Amazon GameLift fleet of game hosting resources. Attributes differ based on\n the fleet's compute type, as follows:
\nEC2 fleet attributes identify a Build resource (for fleets with \n customer game server builds) or a Script resource (for Realtime Servers fleets).
Container fleets have ContainerGroupsAttributes, which identify\n the fleet's ContainerGroupDefinition resources.
Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations\n are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive\n properties, creation/termination time, and fleet status.
\n\n Returned by:\n DescribeFleetAttributes\n
" } }, "com.amazonaws.gamelift#FleetAttributesList": { @@ -6955,21 +8088,30 @@ "InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "The Amazon EC2 instance type that is used for all instances in a fleet. The instance type\n determines the computing resources in use, including CPU, memory, storage, and\n networking capacity. See Amazon Elastic Compute Cloud\n Instance Types for detailed descriptions.
" + "smithy.api#documentation": "The Amazon EC2 instance type that is used for instances in a fleet. Instance type\n determines the computing resources in use, including CPU, memory, storage, and\n networking capacity. See Amazon Elastic Compute Cloud\n Instance Types for detailed descriptions.
" } }, "InstanceCounts": { - "target": "com.amazonaws.gamelift#EC2InstanceCounts" + "target": "com.amazonaws.gamelift#EC2InstanceCounts", + "traits": { + "smithy.api#documentation": "The current number of instances in the fleet, listed by instance status. Counts for pending and\n terminating instances might be non-zero if the fleet is adjusting to a scaling event\n or if access to resources is temporarily affected.
" + } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location for the instance count information, expressed as an Amazon Web Services Region\n code, such as us-west-2.
\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.
" + } } }, "traits": { - "smithy.api#documentation": "Current resource capacity settings in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.
\n\n Related actions\n
\n\n DescribeFleetCapacity | DescribeFleetLocationCapacity | UpdateFleetCapacity\n
" + "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
" } }, "com.amazonaws.gamelift#FleetCapacityExceededException": { @@ -7153,7 +8295,7 @@ } }, "traits": { - "smithy.api#documentation": "Current resource utilization statistics in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.
\n\n Related actions\n
" + "smithy.api#documentation": "Current resource utilization statistics in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home region.
" } }, "com.amazonaws.gamelift#FleetUtilizationList": { @@ -7201,6 +8343,9 @@ { "target": "com.amazonaws.gamelift#CreateBuild" }, + { + "target": "com.amazonaws.gamelift#CreateContainerGroupDefinition" + }, { "target": "com.amazonaws.gamelift#CreateFleet" }, @@ -7246,6 +8391,9 @@ { "target": "com.amazonaws.gamelift#DeleteBuild" }, + { + "target": "com.amazonaws.gamelift#DeleteContainerGroupDefinition" + }, { "target": "com.amazonaws.gamelift#DeleteFleet" }, @@ -7294,6 +8442,9 @@ { "target": "com.amazonaws.gamelift#DescribeCompute" }, + { + "target": "com.amazonaws.gamelift#DescribeContainerGroupDefinition" + }, { "target": "com.amazonaws.gamelift#DescribeEC2InstanceLimits" }, @@ -7393,6 +8544,9 @@ { "target": "com.amazonaws.gamelift#ListCompute" }, + { + "target": "com.amazonaws.gamelift#ListContainerGroupDefinitions" + }, { "target": "com.amazonaws.gamelift#ListFleets" }, @@ -8422,6 +9576,15 @@ } } }, + "com.amazonaws.gamelift#GameLiftAgentEndpointOutput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.gamelift#GameLiftServiceSdkEndpointOutput": { "type": "string", "traits": { @@ -10064,7 +11227,7 @@ } ], "traits": { - "smithy.api#documentation": "Requests authorization to remotely connect to a compute resource in an Amazon GameLift fleet.\n Call this action to connect to an instance in a managed EC2 fleet if the fleet's game\n build uses Amazon GameLift server SDK 5.x or later. To connect to instances with game builds\n that use server SDK 4.x or earlier, call GetInstanceAccess.
\nTo request access to a compute, identify the specific EC2 instance and the fleet it\n belongs to. You can retrieve instances for a managed EC2 fleet by calling ListCompute.
\nIf successful, this operation returns a set of temporary Amazon Web Services credentials, including\n a two-part access key and a session token. Use these credentials with Amazon EC2 Systems Manager (SSM)\n to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.
\n\n Learn more\n
\n\n Remotely connect to fleet\n instances\n
\n\n Debug fleet\n issues\n
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRequests 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
\nTo 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
\nWith 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 Container fleets\n
\nWith 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 Learn more\n
\n\n Debug fleet\n issues\n
\nA unique identifier for the fleet that contains the compute resource you want to connect to. You can use either\n the fleet ID or ARN value.
", + "smithy.api#documentation": "A unique identifier for the fleet that holds the compute resource that you want to connect to. You can use either the\n fleet ID or ARN value.
", "smithy.api#required": {} } }, @@ -10082,7 +11245,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. You can use\n either a registered compute name or an instance ID.
", + "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.
The ID of the fleet that contains the compute resource to be accessed.
" + "smithy.api#documentation": "The ID of the fleet that holds the compute resource to be accessed.
" } }, "FleetArn": { @@ -10123,6 +11286,12 @@ "traits": { "smithy.api#documentation": "A set of temporary Amazon Web Services credentials for use when connecting to the\n compute resource with Amazon EC2 Systems Manager (SSM).
" } + }, + "Target": { + "target": "com.amazonaws.gamelift#SessionTarget", + "traits": { + "smithy.api#documentation": "(For container fleets only) The instance ID where the compute resource is\n running.
" + } } }, "traits": { @@ -10152,7 +11321,7 @@ } ], "traits": { - "smithy.api#documentation": "Requests an authentication token from Amazon GameLift for a registered compute in an Anywhere\n fleet. The game servers that are running on the compute use this token to authenticate\n with the Amazon GameLift service. Each server process must provide a valid authentication token\n in its call to the Amazon GameLift server SDK action InitSDK().
Authentication tokens are valid for a limited time span. Use a mechanism to regularly\n request a fresh authentication token before the current token expires.
\n\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\nRequests 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.
Use this operation based on the fleet compute type:
\nFor EC2 fleets, auth token retrieval and refresh is handled\n automatically. All game servers that are running on all fleet instances have\n access to a valid auth token.
For ANYWHERE and CONTAINER fleets, if you're using\n the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for\n any container or Anywhere compute where the Agent is running. If you're not\n using the Agent, create a mechanism to retrieve and refresh auth tokens for\n computes that are running game server processes.
\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\nThe name of the compute resource you are requesting the authentication token\n for.
", + "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.
Information and credentials that you can use to remotely connect to an instance in an\n EC2 managed fleet. This data type is returned in response to a call to GetInstanceAccess.
" + "smithy.api#documentation": "Information and credentials that you can use to remotely connect to an instance in an\n EC2 managed fleet. This data type is returned in response to a call to \n GetInstanceAccess.
" } }, "com.amazonaws.gamelift#InstanceCredentials": { @@ -10498,7 +11677,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of credentials that allow remote access to an instance in an EC2 managed fleet.\n These credentials are returned in response to a call to GetInstanceAccess, which requests access for instances that are running\n game servers with the Amazon GameLift server SDK version 4.x or earlier.
", + "smithy.api#documentation": "A set of credentials that allow remote access to an instance in an EC2 managed fleet.\n These credentials are returned in response to a call to \n GetInstanceAccess, which requests access for instances that are running\n game servers with the Amazon GameLift server SDK version 4.x or earlier.
", "smithy.api#sensitive": {} } }, @@ -10681,7 +11860,7 @@ } }, "traits": { - "smithy.api#documentation": "A range of IP addresses and port settings that allow inbound traffic to connect to\n server processes on an instance in a fleet. New game sessions are assigned an IP\n address/port number combination, which must fall into the fleet's allowed ranges. Fleets\n with custom game builds must have permissions explicitly set. For Realtime Servers fleets, Amazon GameLift\n automatically opens two port ranges, one for TCP messaging 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 container fleets, the\n port settings must use the same port numbers as the fleet's connection ports.
\nFor Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging\n and one for UDP.
" } }, "com.amazonaws.gamelift#IpPermissionsList": { @@ -11002,7 +12181,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the compute resources in an Amazon GameLift fleet. You can request information for\n either managed EC2 fleets or Anywhere fleets.
\nTo request a list of computes, specify the fleet ID. You can filter the result set by\n location. Use the pagination parameters to retrieve results in a set of sequential\n pages.
\nIf successful, this operation returns the compute resource for the requested fleet.\n For managed EC2 fleets, it returns a list of EC2 instances. For Anywhere fleets, it\n returns a list of registered compute names.
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves information on the compute resources in an Amazon GameLift fleet.
\nTo request a list of computes, specify the fleet ID. Use the pagination parameters to\n retrieve results in a set of sequential pages.
\nYou can filter the result set by location.
\nIf 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:
\nFor EC2 fleets, this operation returns information about the EC2\n instance. Compute names are instance IDs.
For ANYWHERE fleets, this operation returns the compute names and\n details provided when the compute was registered with\n RegisterCompute. The GameLiftServiceSdkEndpoint or\n GameLiftAgentEndpoint is included.
For CONTAINER fleets, this operation returns information about\n containers that are registered as computes, and the instances they're running\n on. Compute names are container names.
The name of a location to retrieve compute resources for.
" + "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).
\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nRetrieves 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.
\nThis operation returns the list of container group definitions in no particular order.
\n\n Learn more\n
\nThe type of container group definitions to retrieve.
\n\n DAEMON -- Daemon container groups run background processes and are deployed once\n per fleet instance.
\n REPLICA -- Replica container groups run your game server application and\n supporting software. Replica groups might be deployed multiple times per fleet\n instance.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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#ListContainerGroupDefinitionsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "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#NonEmptyString", + "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#ListFleets": { "type": "operation", "input": { @@ -11088,7 +12354,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this\n operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor\n specify a Region in your request. You can filter the result set to find only those\n fleets that are deployed with a specific build or script. For fleets that have multiple\n locations, this operation retrieves fleets based on their home Region only.
\nThis operation can be used in the following ways:
\nTo get a list of all fleets in a Region, don't provide a build or script\n identifier.
\nTo get a list of all fleets where a specific custom game build is deployed,\n provide the build ID.
\nTo get a list of all Realtime Servers fleets with a specific configuration script,\n provide the script ID.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a list of fleet IDs that match the request parameters is returned. A\n NextToken value is also returned if there are more result pages to retrieve.
\nFleet resources are not listed in a particular order.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves 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.
\nYou can use operation in the following ways:
\nTo get a list of all fleets in a Region, don't provide a build or script\n identifier.
\nTo get a list of all fleets where a specific game build is deployed, provide\n the build ID.
\nTo get a list of all Realtime Servers fleets with a specific configuration script,\n provide the script ID.
\n To get a list of all fleets with a specific container group definition, provide\n the ContainerGroupDefinition ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
\nIf 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.
\nFleet IDs are returned in no particular order.
\nA 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": { @@ -11565,7 +12837,7 @@ } }, "traits": { - "smithy.api#documentation": "A remote location where a multi-location fleet can deploy game servers for game\n hosting.
" + "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
\nA remote location where a multi-location fleet can deploy game servers for game\n hosting.
" } }, "com.amazonaws.gamelift#LocationConfigurationList": { @@ -11638,7 +12910,7 @@ } }, "traits": { - "smithy.api#documentation": "Properties of a location
" + "smithy.api#documentation": "Properties of a custom location for use in an Amazon GameLift Anywhere fleet. This data type is returned in response to a call to https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html.
" } }, "com.amazonaws.gamelift#LocationModelList": { @@ -12247,6 +13519,25 @@ "smithy.api#pattern": "^\\d{1,5}(?:\\.\\d{1,5})?$" } }, + "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#NonZeroAnd255MaxString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.gamelift#NonZeroAndMaxString": { "type": "string", "traits": { @@ -12268,6 +13559,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.gamelift#NotReadyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.gamelift#NonEmptyString" + } + }, + "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#error": "client" + } + }, "com.amazonaws.gamelift#OperatingSystem": { "type": "enum", "members": { @@ -12940,12 +14243,15 @@ { "target": "com.amazonaws.gamelift#LimitExceededException" }, + { + "target": "com.amazonaws.gamelift#NotReadyException" + }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { - "smithy.api#documentation": "Registers a compute resource to an Amazon GameLift Anywhere fleet. With Anywhere fleets you can\n incorporate your own computing hardware into an Amazon GameLift game hosting solution.
\nTo register a compute to a fleet, give the compute a name (must be unique within the\n fleet) and specify the compute resource's DNS name or IP address. Provide the Anywhere\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.
\nIf successful, this operation returns the compute details, including an Amazon GameLift SDK\n endpoint. Game server processes that run on the compute use this endpoint to communicate\n with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to\n the Amazon GameLift server SDK action InitSDK().
\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\n\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRegisters a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift\n Anywhere fleet or a container fleet.
\nFor 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.
\nTo 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.
\nIf 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().
To view compute details, call DescribeCompute with the compute name.
\n\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\nThe 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
\nThe 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 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": { @@ -13120,7 +14467,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n GameSession.
\nTo request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.
\n Learn more\n
\n\n Create a Build with Files in S3\n
\n\n All APIs by task\n
" + "smithy.api#documentation": "Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n CreateBuild.
\nTo request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.
\n Learn more\n
\n\n Create a Build with Files in S3\n
\n\n All APIs by task\n
" } }, "com.amazonaws.gamelift#RequestUploadCredentialsInput": { @@ -13185,7 +14532,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the fleet ID that an alias is currently pointing to.
\n\n Related actions\n
\n\n All APIs by task\n
" + "smithy.api#documentation": "Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique\n alias identifier.
\nIf the alias has a SIMPLE routing strategy, Amazon GameLift returns a fleet ID.\n If the alias has a TERMINAL routing strategy, the result is a\n TerminalRoutingStrategyException.
\n Related actions\n
\n\n All APIs by task\n
" } }, "com.amazonaws.gamelift#ResolveAliasInput": { @@ -13375,13 +14722,13 @@ "ServerProcesses": { "target": "com.amazonaws.gamelift#ServerProcessList", "traits": { - "smithy.api#documentation": "A collection of server process configurations that identify what server processes to\n run on each instance in a fleet.
" + "smithy.api#documentation": "A collection of server process configurations that identify what server processes to\n run on fleet computes.
" } }, "MaxConcurrentGameSessionActivations": { "target": "com.amazonaws.gamelift#MaxConcurrentGameSessionActivations", "traits": { - "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.
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.
A collection of server process configurations that describe the set of processes to\n run on each instance in a fleet. Server processes run either an executable in a custom\n game build or a Realtime Servers script. Amazon GameLift launches the configured processes, manages their\n life cycle, and replaces them as needed. Each instance checks regularly for an updated\n runtime configuration.
\nA Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes in a runtime configuration, add the values of the\n ConcurrentExecutions parameter for each server process. Learn more\n about Running Multiple\n Processes on a Fleet.
\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nA 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.
\nOn a container fleet, the Amazon GameLift Agent uses the runtime configuration to manage the\n lifecycle of server processes in a replica container group.
\nAn 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.
Retrieves all active game sessions that match a set of search criteria and sorts them\n into a specified order.
\nThis operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or game session placement queue.
\nWhen searching for game sessions, you specify exactly where you want to search and\n provide a search filter expression, a sort expression, or both. A search request can\n search only one fleet, but it can search all of a fleet's locations.
\nThis operation can be used in the following ways:
\nTo search all game sessions that are currently running on all locations in a\n fleet, provide a fleet or alias ID. This approach returns game sessions in the\n fleet's home Region and all remote locations that fit the search\n criteria.
\nTo search all game sessions that are currently running on a specific fleet\n location, provide a fleet or alias ID and a location name. For location, you can\n specify a fleet's home Region or any remote location.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a GameSession object is returned for each game session\n that matches the request. Search finds game sessions that are in ACTIVE\n status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .
To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.
\n\n gameSessionId -- A unique identifier for the game session. You can use either a\n GameSessionId or GameSessionArn value.
\n gameSessionName -- Name assigned to a game\n session. Game session names do not need to be unique to a game session.
\n\n gameSessionProperties -- A set of key-value pairs that can store custom data in a game session.\n For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}.\n The filter expression must specify the GameProperty -- a Key and a string Value to search for the game sessions.
For example, to search for the above key-value pair, specify the following search filter: gameSessionProperties.difficulty = \"novice\".\n All game property values are searched as strings.
\n For examples of searching game sessions, see the ones below, and also see Search game sessions by game property.\n
\n\n maximumSessions -- Maximum number of player\n sessions allowed for a game session.
\n\n creationTimeMillis -- Value indicating when a\n game session was created. It is expressed in Unix time as milliseconds.
\n\n playerSessionCount -- Number of players\n currently connected to a game session. This value changes rapidly as players\n join the session or drop out.
\n\n hasAvailablePlayerSessions -- Boolean value\n indicating whether a game session has reached its maximum number of players. It\n is highly recommended that all search requests include this filter attribute to\n optimize search performance and return only sessions that players can join.\n
\nReturned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.
\n All APIs by task\n
", + "smithy.api#documentation": "Retrieves all active game sessions that match a set of search criteria and sorts them\n into a specified order.
\nThis operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or a game session placement queue.
\nWhen searching for game sessions, you specify exactly where you want to search and\n provide a search filter expression, a sort expression, or both. A search request can\n search only one fleet, but it can search all of a fleet's locations.
\nThis operation can be used in the following ways:
\nTo search all game sessions that are currently running on all locations in a\n fleet, provide a fleet or alias ID. This approach returns game sessions in the\n fleet's home Region and all remote locations that fit the search\n criteria.
\nTo search all game sessions that are currently running on a specific fleet\n location, provide a fleet or alias ID and a location name. For location, you can\n specify a fleet's home Region or any remote location.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a GameSession object is returned for each game session\n that matches the request. Search finds game sessions that are in ACTIVE\n status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .
To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.
\n\n gameSessionId -- A unique identifier for the game session. You can use either a\n GameSessionId or GameSessionArn value.
\n gameSessionName -- Name assigned to a game\n session. Game session names do not need to be unique to a game session.
\n\n gameSessionProperties -- A set of key-value pairs that can store custom data in a game session.\n For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}.\n The filter expression must specify the GameProperty -- a Key and a string Value to search for the game sessions.
For example, to search for the above key-value pair, specify the following search filter: gameSessionProperties.difficulty = \"novice\".\n All game property values are searched as strings.
\n For examples of searching game sessions, see the ones below, and also see Search game sessions by game property.\n
\n\n maximumSessions -- Maximum number of player\n sessions allowed for a game session.
\n\n creationTimeMillis -- Value indicating when a\n game session was created. It is expressed in Unix time as milliseconds.
\n\n playerSessionCount -- Number of players\n currently connected to a game session. This value changes rapidly as players\n join the session or drop out.
\n\n hasAvailablePlayerSessions -- Boolean value\n indicating whether a game session has reached its maximum number of players. It\n is highly recommended that all search requests include this filter attribute to\n optimize search performance and return only sessions that players can join.\n
\nReturned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.
\n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -13798,13 +15145,13 @@ "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.
", + "smithy.api#documentation": "The number of server processes using this configuration that run concurrently on each\n instance or container..
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A set of instructions for launching server processes on each instance in a fleet.\n Server processes run either an executable in a custom game build or a Realtime Servers script.\n Server process configurations are part of a fleet's runtime configuration.
" + "smithy.api#documentation": "A set of instructions for launching server processes on fleet computes. Server\n processes run either an executable in a custom game build or a Realtime Servers script. Server\n process configurations are part of a fleet's runtime configuration.
" } }, "com.amazonaws.gamelift#ServerProcessList": { @@ -13830,6 +15177,21 @@ "smithy.api#pattern": "^\\d+\\.\\d+\\.\\d+$" } }, + "com.amazonaws.gamelift#SessionTarget": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 400 + } + } + }, + "com.amazonaws.gamelift#Sha256": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sha256:[a-fA-F0-9]{64}$" + } + }, "com.amazonaws.gamelift#SnsArnStringModel": { "type": "string", "traits": { @@ -14210,7 +15572,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.
\nStopping 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.
\nThis operation can be used in the following ways:
\nTo stop actions on instances in the fleet's home Region, provide a fleet ID\n and the type of actions to suspend.
\nTo stop actions on instances in one of the fleet's remote locations, provide a\n fleet ID, a location name, and the type of actions to suspend.
\nIf successful, Amazon GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity.
\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.
\nStopping 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.
\nThis operation can be used in the following ways:
\nTo stop actions on instances in the fleet's home Region, provide a fleet ID\n and the type of actions to suspend.
\nTo stop actions on instances in one of the fleet's remote locations, provide a\n fleet ID, a location name, and the type of actions to suspend.
\nIf 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": { @@ -14727,7 +16089,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates properties for an alias. To update properties, specify the alias ID to be\n updated and provide the information to be changed. To reassign an alias to another\n fleet, provide an updated routing strategy. If successful, the updated alias record is\n returned.
\n\n Related actions\n
\n\n All APIs by task\n
" + "smithy.api#documentation": "Updates properties for an alias. Specify the unique identifier of the alias to be\n updated and the new property values. When reassigning an alias to a new fleet, provide\n an updated routing strategy. If successful, the updated alias record is returned.
\n\n Related actions\n
\n\n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateAliasInput": { @@ -14878,7 +16240,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a fleet's mutable attributes, including game session protection and resource\n creation limits.
\nTo update fleet attributes, specify the fleet ID and the property values that you want\n to change.
\nIf successful, an updated FleetAttributes object is returned.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" + "smithy.api#documentation": "Updates a fleet's mutable attributes, such as game session protection and resource\n creation limits.
\nTo update fleet attributes, specify the fleet ID and the property values that you want\n to change. If successful, Amazon GameLift returns the identifiers for the updated fleet.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" } }, "com.amazonaws.gamelift#UpdateFleetAttributesInput": { @@ -14988,7 +16350,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates capacity settings for a fleet. For fleets with multiple locations, use this\n operation to manage capacity settings in each location individually. Fleet capacity\n determines the number of game sessions and players that can be hosted based on the fleet\n configuration. Use this operation to set the following fleet capacity properties:
\nMinimum/maximum size: Set hard limits on fleet capacity. Amazon GameLift cannot set\n the fleet's capacity to a value outside of this range, whether the capacity is\n changed manually or through automatic scaling.
\nDesired capacity: Manually set the number of Amazon EC2 instances to be maintained\n in a fleet location. Before changing a fleet's desired capacity, you may want to\n call DescribeEC2InstanceLimits to get the maximum capacity of the\n fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to\n adjust capacity based on player demand.
\nThis operation can be used in the following ways:
\nTo 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.
To update capacity for a fleet's remote location, include the\n Location parameter set to the location to be updated. The\n location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in\n desired capacity, Amazon GameLift initiates steps to start new instances or terminate existing\n instances in the requested fleet location. This continues until the location's active\n instance count matches the new desired instance count. You can track a fleet's current\n capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is\n higher than the instance type's limit, the LimitExceeded exception\n occurs.
\n Learn more\n
\n " + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nUpdates 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.
\nUse this operation to set these fleet capacity properties:
\nMinimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a \n request--either through manual update or automatic scaling--it won't change the capacity \n to a value outside of this range.
\nDesired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 \n instances to be maintained. \n Before changing a fleet's desired capacity, check the maximum capacity of the\n fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits.
\nTo 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.
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.
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.
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 " } }, "com.amazonaws.gamelift#UpdateFleetCapacityInput": { @@ -15089,7 +16451,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates permissions that allow inbound traffic to connect to game sessions that are\n being hosted on instances in the fleet.
\nTo update settings, specify the fleet ID to be updated and specify the changes to be\n made. List the permissions you want to add in\n InboundPermissionAuthorizations, and permissions you want to remove in\n InboundPermissionRevocations. Permissions to be removed must match\n existing fleet permissions.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote\n locations, port setting updates can take time to propagate across all locations. You can\n check the status of updates in each location by calling\n DescribeFleetPortSettings with a location name.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" + "smithy.api#documentation": "Updates permissions that allow inbound traffic to connect to game sessions in the\n fleet.
\nTo update settings, specify the fleet ID to be updated and specify the changes to be\n made. List the permissions you want to add in\n InboundPermissionAuthorizations, and permissions you want to remove in\n InboundPermissionRevocations. Permissions to be removed must match\n existing fleet permissions.
For a container fleet, inbound permissions must specify port numbers that are defined\n in the fleet's connection port settings.
\nIf successful, the fleet ID for the updated fleet is returned. For fleets with remote\n locations, port setting updates can take time to propagate across all locations. You can\n check the status of updates in each location by calling\n DescribeFleetPortSettings with a location name.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" } }, "com.amazonaws.gamelift#UpdateFleetPortSettingsInput": { @@ -15644,6 +17006,9 @@ { "target": "com.amazonaws.gamelift#InvalidRequestException" }, + { + "target": "com.amazonaws.gamelift#LimitExceededException" + }, { "target": "com.amazonaws.gamelift#NotFoundException" }, @@ -15652,7 +17017,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the current runtime configuration for the specified fleet, which tells Amazon GameLift\n how to launch server processes on all instances in the fleet. You can update a fleet's\n runtime configuration at any time after the fleet is created; it does not need to be in\n ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a\n RuntimeConfiguration with an updated set of server process\n configurations.
If successful, the fleet's runtime configuration settings are updated. Each instance\n in the fleet regularly checks for and retrieves updated runtime configurations.\n Instances immediately begin complying with the new configuration by launching new server\n processes or not replacing existing processes when they shut down. Updating a fleet's\n runtime configuration never affects existing server processes.
\n\n Learn more\n
\n\n Setting up 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 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.
To update runtime configuration, specify the fleet ID and provide a\n RuntimeConfiguration with an updated set of server process\n configurations.
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": { @@ -15670,7 +17035,7 @@ "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Instructions for launching server processes on each instance in the fleet. Server\n processes run either a custom game build executable or a Realtime Servers script. The runtime\n configuration lists the types of server processes to run on an instance, how to launch\n them, and the number of processes to run concurrently.
", + "smithy.api#documentation": "Instructions for launching server processes on fleet computes. Server processes run\n either a custom game build executable or a Realtime Servers script. The runtime configuration lists\n the types of server processes to run, how to launch them, and the number of processes to\n run concurrently.
", "smithy.api#required": {} } } @@ -15685,7 +17050,7 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "The runtime configuration currently in use by all instances in the fleet. If the\n update was successful, all property changes are shown.
" + "smithy.api#documentation": "The runtime configuration currently in use by computes in the fleet. If the update is\n successful, all property changes are shown.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/ssm.json b/codegen/sdk-codegen/aws-models/ssm.json index 7fb525c8648..9622ad1d888 100644 --- a/codegen/sdk-codegen/aws-models/ssm.json +++ b/codegen/sdk-codegen/aws-models/ssm.json @@ -533,6 +533,9 @@ { "target": "com.amazonaws.ssm#DescribeInstancePatchStatesForPatchGroup" }, + { + "target": "com.amazonaws.ssm#DescribeInstanceProperties" + }, { "target": "com.amazonaws.ssm#DescribeInventoryDeletions" }, @@ -1868,6 +1871,15 @@ } } }, + "com.amazonaws.ssm#Architecture": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#AssociateOpsItemRelatedItem": { "type": "operation", "input": { @@ -6186,7 +6198,7 @@ "Name": { "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "A name for the SSM document.
\nYou can't use the following strings as document name prefixes. These are reserved by Amazon Web Services\n for use as document name prefixes:
\n\n aws\n
\n amazon\n
\n amzn\n
A name for the SSM document.
\nYou can't use the following strings as document name prefixes. These are reserved by Amazon Web Services\n for use as document name prefixes:
\n\n aws\n
\n amazon\n
\n amzn\n
\n AWSEC2\n
\n AWSConfigRemediation\n
\n AWSSupport\n
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
When using a rate schedule, if you provide a start date that occurs in the past, the\n current date and time are used as the start date.
\nAn API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceProperties", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssm#DescribeInstancePropertiesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ssm#DescribeInstancePropertiesRequest": { + "type": "structure", + "members": { + "InstancePropertyFilterList": { + "target": "com.amazonaws.ssm#InstancePropertyFilterList", + "traits": { + "smithy.api#documentation": "An array of instance property filters.
" + } + }, + "FiltersWithOperator": { + "target": "com.amazonaws.ssm#InstancePropertyStringFilterList", + "traits": { + "smithy.api#documentation": "The request filters to use with the operator.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssm#DescribeInstancePropertiesMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return for the call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "The token provided by a previous request to use to return the next set of properties.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssm#DescribeInstancePropertiesResult": { + "type": "structure", + "members": { + "InstanceProperties": { + "target": "com.amazonaws.ssm#InstanceProperties", + "traits": { + "smithy.api#documentation": "Properties for the managed instances.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of properties to return. Use this token to get the next set of\n results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssm#DescribeInventoryDeletions": { "type": "operation", "input": { @@ -13900,7 +14014,7 @@ "Names": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For\n parameters shared with you from another account, you must use the full ARNs.
\nTo query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".
For more information about shared parameters, see Working with\n shared parameters in the Amazon Web Services Systems Manager User Guide.
", + "smithy.api#documentation": "The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For\n parameters shared with you from another account, you must use the full ARNs.
\nTo query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".
The results for GetParameters requests are listed in alphabetical order in\n query responses.
For information about shared parameters, see Working with\n shared parameters in the Amazon Web Services Systems Manager User Guide.
", "smithy.api#required": {} } }, @@ -14921,6 +15035,15 @@ } } }, + "com.amazonaws.ssm#InstanceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, "com.amazonaws.ssm#InstancePatchState": { "type": "structure", "members": { @@ -15190,6 +15313,403 @@ } } }, + "com.amazonaws.ssm#InstanceProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstanceProperty", + "traits": { + "smithy.api#xmlName": "InstanceProperty" + } + } + }, + "com.amazonaws.ssm#InstanceProperty": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssm#InstanceName", + "traits": { + "smithy.api#documentation": "The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.
The ID of the managed node.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.ssm#InstanceType", + "traits": { + "smithy.api#documentation": "The instance type of the managed node. For example, t3.large.
" + } + }, + "InstanceRole": { + "target": "com.amazonaws.ssm#InstanceRole", + "traits": { + "smithy.api#documentation": "The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.
" + } + }, + "KeyName": { + "target": "com.amazonaws.ssm#KeyName", + "traits": { + "smithy.api#documentation": "The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.
" + } + }, + "InstanceState": { + "target": "com.amazonaws.ssm#InstanceState", + "traits": { + "smithy.api#documentation": "The current state of the node.
" + } + }, + "Architecture": { + "target": "com.amazonaws.ssm#Architecture", + "traits": { + "smithy.api#documentation": "The CPU architecture of the node. For example, x86_64.
" + } + }, + "IPAddress": { + "target": "com.amazonaws.ssm#IPAddress", + "traits": { + "smithy.api#documentation": "The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.
" + } + }, + "LaunchTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp for when the node was launched.
" + } + }, + "PingStatus": { + "target": "com.amazonaws.ssm#PingStatus", + "traits": { + "smithy.api#documentation": "Connection status of the SSM Agent on the managed node.
" + } + }, + "LastPingDateTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The date and time when the SSM Agent last pinged the Systems Manager service.
" + } + }, + "AgentVersion": { + "target": "com.amazonaws.ssm#Version", + "traits": { + "smithy.api#documentation": "The version of SSM Agent running on your managed node.
" + } + }, + "PlatformType": { + "target": "com.amazonaws.ssm#PlatformType", + "traits": { + "smithy.api#documentation": "The operating system platform type of the managed node. For example, Windows.
" + } + }, + "PlatformName": { + "target": "com.amazonaws.ssm#PlatformName", + "traits": { + "smithy.api#documentation": "The name of the operating system platform running on your managed node.
" + } + }, + "PlatformVersion": { + "target": "com.amazonaws.ssm#PlatformVersion", + "traits": { + "smithy.api#documentation": "The version of the OS platform running on your managed node.
" + } + }, + "ActivationId": { + "target": "com.amazonaws.ssm#ActivationId", + "traits": { + "smithy.api#documentation": "The activation ID created by Systems Manager when the server or virtual machine (VM) was registered
" + } + }, + "IamRole": { + "target": "com.amazonaws.ssm#IamRole", + "traits": { + "smithy.api#documentation": "The IAM role used in the hybrid activation to register the node with Systems Manager.
" + } + }, + "RegistrationDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The date the node was registered with Systems Manager.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The type of managed node.
" + } + }, + "ComputerName": { + "target": "com.amazonaws.ssm#ComputerName", + "traits": { + "smithy.api#documentation": "The fully qualified host name of the managed node.
" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.ssm#StatusName", + "traits": { + "smithy.api#documentation": "The status of the State Manager association applied to the managed node.
" + } + }, + "LastAssociationExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The date the association was last run.
" + } + }, + "LastSuccessfulAssociationExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The last date the association was successfully run.
" + } + }, + "AssociationOverview": { + "target": "com.amazonaws.ssm#InstanceAggregatedAssociationOverview" + }, + "SourceId": { + "target": "com.amazonaws.ssm#SourceId", + "traits": { + "smithy.api#documentation": "The ID of the source resource.
" + } + }, + "SourceType": { + "target": "com.amazonaws.ssm#SourceType", + "traits": { + "smithy.api#documentation": "The type of the source resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing various properties of a managed node.
" + } + }, + "com.amazonaws.ssm#InstancePropertyFilter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.ssm#InstancePropertyFilterKey", + "traits": { + "smithy.api#documentation": "The name of the filter.
", + "smithy.api#required": {} + } + }, + "valueSet": { + "target": "com.amazonaws.ssm#InstancePropertyFilterValueSet", + "traits": { + "smithy.api#documentation": "The filter values.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.
" + } + }, + "com.amazonaws.ssm#InstancePropertyFilterKey": { + "type": "enum", + "members": { + "INSTANCE_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceIds" + } + }, + "AGENT_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AgentVersion" + } + }, + "PING_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PingStatus" + } + }, + "PLATFORM_TYPES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlatformTypes" + } + }, + "DOCUMENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DocumentName" + } + }, + "ACTIVATION_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActivationIds" + } + }, + "IAM_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamRole" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + }, + "ASSOCIATION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociationStatus" + } + } + } + }, + "com.amazonaws.ssm#InstancePropertyFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstancePropertyFilter", + "traits": { + "smithy.api#xmlName": "InstancePropertyFilter" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.ssm#InstancePropertyFilterOperator": { + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equal" + } + }, + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEqual" + } + }, + "BEGIN_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BeginWith" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + } + } + }, + "com.amazonaws.ssm#InstancePropertyFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#pattern": "^.{1,100000}$" + } + }, + "com.amazonaws.ssm#InstancePropertyFilterValueSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstancePropertyFilterValue", + "traits": { + "smithy.api#xmlName": "InstancePropertyFilterValue" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.ssm#InstancePropertyStringFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ssm#InstancePropertyStringFilterKey", + "traits": { + "smithy.api#documentation": "The filter key name to describe your managed nodes.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.ssm#InstancePropertyFilterValueSet", + "traits": { + "smithy.api#documentation": "The filter key name to describe your managed nodes.
", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.ssm#InstancePropertyFilterOperator", + "traits": { + "smithy.api#documentation": "The operator used by the filter call.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The filters to describe or get information about your managed nodes.
" + } + }, + "com.amazonaws.ssm#InstancePropertyStringFilterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#pattern": "^.{1,100000}$" + } + }, + "com.amazonaws.ssm#InstancePropertyStringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstancePropertyStringFilter", + "traits": { + "smithy.api#xmlName": "InstancePropertyStringFilter" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.ssm#InstanceRole": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, + "com.amazonaws.ssm#InstanceState": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#InstanceTagName": { "type": "string", "traits": { @@ -15199,6 +15719,15 @@ } } }, + "com.amazonaws.ssm#InstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#InstancesCount": { "type": "integer", "traits": { @@ -15615,6 +16144,22 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#InvalidInstancePropertyFilterValue": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssm#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidInstancePropertyFilterValue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified filter value isn't valid.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#InvalidInventoryGroupException": { "type": "structure", "members": { @@ -16766,6 +17311,15 @@ "target": "com.amazonaws.ssm#TagKey" } }, + "com.amazonaws.ssm#KeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, "com.amazonaws.ssm#LabelParameterVersion": { "type": "operation", "input": { @@ -23654,6 +24208,15 @@ } } }, + "com.amazonaws.ssm#PlatformName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#PlatformType": { "type": "enum", "members": { @@ -23686,6 +24249,15 @@ } } }, + "com.amazonaws.ssm#PlatformVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#PoliciesLimitExceededException": { "type": "structure", "members": { @@ -24496,7 +25068,7 @@ "ServiceRoleArn": { "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a \n maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's \n service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run \n RegisterTaskWithMaintenanceWindow.
For more information, see Using \n service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "TaskType": { @@ -27708,7 +28280,7 @@ } }, "traits": { - "smithy.api#documentation": "An array of search criteria that targets managed nodes using a key-value pair that you\n specify.
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSupported formats include the following.
\n\n Key=InstanceIds,Values=\n
\n Key=tag:\n
\n Key=tag-key,Values=\n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=\n
\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=\n
\n Automation targets only:\n Key=ResourceGroup;Values=\n
For example:
\n\n Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE\n
\n Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3\n
\n Key=tag-key,Values=Name,Instance-Type,CostCenter\n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=ProductionResourceGroup\n
This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
\n\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n
This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.
\n\n Automation targets only:\n Key=ResourceGroup,Values=MyResourceGroup\n
\n State Manager association targets only:\n Key=InstanceIds,Values=*\n
This example demonstrates how to target all managed instances in the Amazon Web Services Region where\n the association was created.
\nFor more information about how to send commands that target managed nodes using\n Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.
An array of search criteria that targets managed nodes using a key-value pair that you\n specify.
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSupported formats include the following.
\n\n For all Systems Manager capabilities:\n
\n\n Key=tag-key,Values=tag-value-1,tag-value-2\n
\n For Automation and Change Manager:\n
\n\n Key=tag:tag-key,Values=tag-value\n
\n Key=ResourceGroup,Values=resource-group-name\n
\n Key=ParameterValues,Values=value-1,value-2,value-3\n
To target all instances in the Amazon Web Services Region:
\n\n Key=AWS::EC2::Instance,Values=*\n
\n Key=InstanceIds,Values=*\n
\n For Run Command and Maintenance Windows:\n
\n\n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n
\n Key=tag:tag-key,Values=tag-value-1,tag-value-2\n
\n Key=resource-groups:Name,Values=resource-group-name\n
Additionally, Maintenance Windows support targeting resource types:
\n\n Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2\n
\n For State Manager:\n
\n\n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n
\n Key=tag:tag-key,Values=tag-value-1,tag-value-2\n
To target all instances in the Amazon Web Services Region:
\n\n Key=InstanceIds,Values=*\n
For more information about how to send commands that target managed nodes using\n Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
When using a rate schedule, if you provide a start date that occurs in the past, the\n current date and time are used as the start date.
\nThe Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a \n maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's \n service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run \n RegisterTaskWithMaintenanceWindow.
For more information, see Using \n service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "TaskParameters": {