diff --git a/CHANGELOG.md b/CHANGELOG.md index 3eaa8532c9..19195fac14 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,23 @@ +Release v1.44.247 (2023-04-20) +=== + +### Service Client Updates +* `service/chime`: Updates service API and documentation + * Adds support for Hindi and Thai languages and additional Amazon Transcribe parameters to the StartMeetingTranscription API. +* `service/chime-sdk-media-pipelines`: Updates service API and documentation +* `service/chime-sdk-meetings`: Updates service API and documentation +* `service/gamelift`: Updates service API and documentation + * Amazon GameLift supports creating Builds for Windows 2016 operating system. +* `service/guardduty`: Updates service API and documentation + * This release adds support for the new Lambda Protection feature. +* `service/iot`: Updates service API and paginators + * Support additional OTA states in GetOTAUpdate API +* `service/sagemaker`: Updates service API and documentation + * Amazon SageMaker Canvas adds ModelRegisterSettings support for CanvasAppSettings. +* `service/snowball`: Updates service API and documentation + * Adds support for Amazon S3 compatible storage. AWS Snow Family customers can now use Amazon S3 compatible storage on Snowball Edge devices. Also adds support for V3_5S. This is a refreshed AWS Snowball Edge Storage Optimized device type with 210TB SSD (customer usable). +* `service/wafv2`: Updates service API and documentation + Release v1.44.246 (2023-04-19) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index f170a3b53a..2ad1828f75 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -12966,6 +12966,9 @@ var awsPartition = partition{ endpointKey{ Region: "ap-southeast-3", }: endpoint{}, + endpointKey{ + Region: "ap-southeast-4", + }: endpoint{}, endpointKey{ Region: "ca-central-1", }: endpoint{}, @@ -15630,6 +15633,14 @@ var awsPartition = partition{ }, Deprecated: boxedTrue, }, + endpointKey{ + Region: "il-central-1-fips", + }: endpoint{ + Hostname: "kms-fips.il-central-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "il-central-1", + }, + }, endpointKey{ Region: "me-central-1", }: endpoint{}, diff --git a/aws/version.go b/aws/version.go index fa533405a8..0a12d8f426 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.44.246" +const SDKVersion = "1.44.247" diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json index bc20038441..1ebbf87c42 100644 --- a/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json @@ -1584,7 +1584,8 @@ "S3RecordingSinkConfiguration":{ "type":"structure", "members":{ - "Destination":{"shape":"Arn"} + "Destination":{"shape":"Arn"}, + "RecordingFileFormat":{"shape":"RecordingFileFormat"} } }, "S3RecordingSinkRuntimeConfiguration":{ diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json index 62e11ea3a8..e1724081ad 100644 --- a/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json @@ -56,8 +56,8 @@ "CreateMediaCapturePipelineRequest$SinkArn": "

The ARN of the sink type.

", "CreateMediaInsightsPipelineConfigurationRequest$ResourceAccessRoleArn": "

The ARN of the role used by the service to access Amazon Web Services resources, including Transcribe and Transcribe Call Analytics, on the caller’s behalf.

", "CreateMediaInsightsPipelineRequest$MediaInsightsPipelineConfigurationArn": "

The ARN of the pipeline's configuration.

", - "KinesisDataStreamSinkConfiguration$InsightsTarget": "

The URL of the sink, https://aws.amazon.com/kinesis/data-streams/.

", - "LambdaFunctionSinkConfiguration$InsightsTarget": "

The URL of the sink, https://aws.amazon.com/kinesis/data-streams/.

", + "KinesisDataStreamSinkConfiguration$InsightsTarget": "

The ARN of the sink.

", + "LambdaFunctionSinkConfiguration$InsightsTarget": "

The ARN of the sink.

", "MediaCapturePipeline$SourceArn": "

ARN of the source from which the media artifacts are saved.

", "MediaCapturePipeline$SinkArn": "

ARN of the destination to which the media artifacts are saved.

", "MediaCapturePipelineSourceConfiguration$MediaPipelineArn": "

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

", @@ -67,10 +67,10 @@ "MediaInsightsPipelineConfiguration$ResourceAccessRoleArn": "

The ARN of the role used by the service to access Amazon Web Services resources.

", "MediaInsightsPipelineConfigurationSummary$MediaInsightsPipelineConfigurationArn": "

The ARN of the media insights pipeline configuration.

", "S3BucketSinkConfiguration$Destination": "

The destination URL of the S3 bucket.

", - "S3RecordingSinkConfiguration$Destination": "

The URL of the Amazon S3 bucket used as the recording sink.

", - "S3RecordingSinkRuntimeConfiguration$Destination": "

The URL of the S3 bucket used as the runtime sink.

", - "SnsTopicSinkConfiguration$InsightsTarget": "

The URL of the SNS sink, https://aws.amazon.com/kinesis/data-streams/.

", - "SqsQueueSinkConfiguration$InsightsTarget": "

The URL of the SQS sink, https://aws.amazon.com/kinesis/data-streams/.

", + "S3RecordingSinkConfiguration$Destination": "

The default URI of the Amazon S3 bucket used as the recording sink.

", + "S3RecordingSinkRuntimeConfiguration$Destination": "

The URI of the S3 bucket used as the sink.

", + "SnsTopicSinkConfiguration$InsightsTarget": "

The ARN of the SNS sink.

", + "SqsQueueSinkConfiguration$InsightsTarget": "

The ARN of the SQS sink.

", "UpdateMediaInsightsPipelineConfigurationRequest$ResourceAccessRoleArn": "

The ARN of the role used by the service to access Amazon Web Services resources.

" } }, @@ -179,7 +179,7 @@ "CategoryNameList": { "base": null, "refs": { - "AmazonTranscribeCallAnalyticsProcessorConfiguration$CallAnalyticsStreamCategories": "

By default, all CategoryEvents will be sent to the insights target. If this parameter is specified, only included categories will be sent to the insights target.

" + "AmazonTranscribeCallAnalyticsProcessorConfiguration$CallAnalyticsStreamCategories": "

By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

" } }, "ChannelDefinition": { @@ -877,17 +877,17 @@ "base": null, "refs": { "AmazonTranscribeCallAnalyticsProcessorConfiguration$PiiEntityTypes": "

Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Length Constraints: Minimum length of 1. Maximum length of 300.

", - "AmazonTranscribeProcessorConfiguration$PiiEntityTypes": "

The types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Length Constraints: Minimum length of 1. Maximum length of 300.

" + "AmazonTranscribeProcessorConfiguration$PiiEntityTypes": "

The types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

If you leave this parameter empty, the default behavior is equivalent to ALL.

" } }, "PostCallAnalyticsSettings": { - "base": "

The settings for a post-call voice analytics task.

", + "base": "

Allows you to specify additional settings for your Call Analytics post-call request, including output locations for your redacted transcript, which IAM role to use, and which encryption key to use.

DataAccessRoleArn and OutputLocation are required fields.

PostCallAnalyticsSettings provides the same insights as a Call Analytics post-call transcription. For more information, refer to Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.

", "refs": { "AmazonTranscribeCallAnalyticsProcessorConfiguration$PostCallAnalyticsSettings": "

The settings for a post-call analysis task in an analytics configuration.

" } }, "PresenterOnlyConfiguration": { - "base": "

Defines the configuration for a presenter only video tile.

", + "base": "

Defines the configuration for a presenter-only video tile.

", "refs": { "GridViewConfiguration$PresenterOnlyConfiguration": "

Defines the configuration options for a presenter only video tile.

" } @@ -927,11 +927,12 @@ "RecordingFileFormat": { "base": null, "refs": { - "S3RecordingSinkRuntimeConfiguration$RecordingFileFormat": "

The file formats for the audio and video files sent to the Amazon S3 bucket.

" + "S3RecordingSinkConfiguration$RecordingFileFormat": "

The default file format for the media files sent to the Amazon S3 bucket.

", + "S3RecordingSinkRuntimeConfiguration$RecordingFileFormat": "

The file format for the media files sent to the Amazon S3 bucket.

" } }, "RecordingStreamConfiguration": { - "base": "

A structure the holds the settings for recording audio and video.

", + "base": "

A structure that holds the settings for recording media.

", "refs": { "RecordingStreamList$member": null } @@ -976,13 +977,13 @@ } }, "S3RecordingSinkConfiguration": { - "base": "

The structure that holds the settings for transmitting audio and video to the Amazon S3 bucket.

", + "base": "

The structure that holds the settings for transmitting media to the Amazon S3 bucket. These values are used as defaults if S3RecordingSinkRuntimeConfiguration is not specified.

", "refs": { "MediaInsightsPipelineConfigurationElement$S3RecordingSinkConfiguration": "

The configuration settings for the Amazon S3 recording bucket in a media insights pipeline configuration element.

" } }, "S3RecordingSinkRuntimeConfiguration": { - "base": "

A structure that holds the settings for transmitting audio and video recordings to the runtime Amazon S3 bucket.

", + "base": "

A structure that holds the settings for transmitting media files to the Amazon S3 bucket. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.

", "refs": { "CreateMediaInsightsPipelineRequest$S3RecordingSinkRuntimeConfiguration": "

The runtime configuration for the S3 recording sink.

", "MediaInsightsPipeline$S3RecordingSinkRuntimeConfiguration": "

The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.

" @@ -1042,7 +1043,7 @@ } }, "SqsQueueSinkConfiguration": { - "base": "

The URL of the SQS sink.

", + "base": "

The configuration settings for the SQS sink.

", "refs": { "MediaInsightsPipelineConfigurationElement$SqsQueueSinkConfiguration": "

The configuration settings for an SQS queue sink in a media insights pipeline configuration element.

" } @@ -1085,7 +1086,7 @@ "NotFoundException$RequestId": "

The request ID associated with the call responsible for the exception.

", "PostCallAnalyticsSettings$OutputLocation": "

The URL of the Amazon S3 bucket that contains the post-call data.

", "PostCallAnalyticsSettings$DataAccessRoleArn": "

The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.

", - "PostCallAnalyticsSettings$OutputEncryptionKMSKeyId": "

The ID of the KMS (Key Management System) key used to encrypt the output.

", + "PostCallAnalyticsSettings$OutputEncryptionKMSKeyId": "

The ID of the KMS (Key Management Service) key used to encrypt the output.

", "ResourceLimitExceededException$Message": null, "ResourceLimitExceededException$RequestId": "

The request ID associated with the call responsible for the exception.

", "ServiceFailureException$Message": null, diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/endpoint-tests-1.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/endpoint-tests-1.json index 7eb9374850..c13889f2fe 100644 --- a/models/apis/chime-sdk-media-pipelines/2021-07-15/endpoint-tests-1.json +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { + "Region": "ap-southeast-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-southeast-1" + "UseDualStack": false } }, { @@ -21,9 +21,9 @@ } }, "params": { + "Region": "eu-central-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { @@ -34,9 +34,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -47,9 +47,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -60,9 +60,9 @@ } }, "params": { + "Region": "us-west-2", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -73,9 +73,9 @@ } }, "params": { + "Region": "us-west-2", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -86,9 +86,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -99,9 +99,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -112,9 +112,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -125,9 +125,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -138,9 +138,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -151,9 +151,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -164,9 +164,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -177,9 +177,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -190,9 +190,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -203,9 +203,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -214,9 +214,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -227,9 +227,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -238,9 +238,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -251,9 +251,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -262,9 +262,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "Region": "us-isob-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -275,9 +275,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -286,9 +286,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "Region": "us-isob-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -299,9 +299,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -312,9 +312,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -337,9 +337,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -349,9 +349,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, diff --git a/models/apis/chime-sdk-meetings/2021-07-15/api-2.json b/models/apis/chime-sdk-meetings/2021-07-15/api-2.json index 4a7871e5ba..e003ea2c8e 100644 --- a/models/apis/chime-sdk-meetings/2021-07-15/api-2.json +++ b/models/apis/chime-sdk-meetings/2021-07-15/api-2.json @@ -596,7 +596,9 @@ "LanguageModelName":{"shape":"TranscribeLanguageModelName"}, "IdentifyLanguage":{"shape":"Boolean"}, "LanguageOptions":{"shape":"TranscribeLanguageOptions"}, - "PreferredLanguage":{"shape":"TranscribeLanguageCode"} + "PreferredLanguage":{"shape":"TranscribeLanguageCode"}, + "VocabularyNames":{"shape":"TranscribeVocabularyNamesOrFilterNamesString"}, + "VocabularyFilterNames":{"shape":"TranscribeVocabularyNamesOrFilterNamesString"} } }, "ExternalMeetingId":{ @@ -985,7 +987,9 @@ "pt-BR", "ja-JP", "ko-KR", - "zh-CN" + "zh-CN", + "th-TH", + "hi-IN" ] }, "TranscribeLanguageModelName":{ @@ -1078,6 +1082,12 @@ "tag" ] }, + "TranscribeVocabularyNamesOrFilterNamesString":{ + "type":"string", + "max":3000, + "min":1, + "pattern":"^[a-zA-Z0-9,-._]+" + }, "TranscriptionConfiguration":{ "type":"structure", "members":{ diff --git a/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json b/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json index 94c3c5ffd4..7d065cb4f0 100644 --- a/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json +++ b/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json @@ -3,7 +3,7 @@ "service": "

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.

", "operations": { "BatchCreateAttendee": "

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", - "BatchUpdateAttendeeCapabilitiesExcept": "

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", + "BatchUpdateAttendeeCapabilitiesExcept": "

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", "CreateAttendee": "

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "CreateMeeting": "

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "CreateMeetingWithAttendees": "

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", @@ -13,11 +13,11 @@ "GetMeeting": "

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "ListAttendees": "

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "ListTagsForResource": "

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

", - "StartMeetingTranscription": "

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

", + "StartMeetingTranscription": "

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

", "StopMeetingTranscription": "

Stops transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

", "TagResource": "

The resource that supports tags.

", "UntagResource": "

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

Minimum permissions

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

tag:UntagResource

ChimeSDKMeetings:DeleteTags

", - "UpdateAttendeeCapabilities": "

The capabilties that you want to update.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

" + "UpdateAttendeeCapabilities": "

The capabilities that you want to update.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

" }, "shapes": { "AmazonResourceName": { @@ -49,13 +49,13 @@ } }, "AttendeeCapabilities": { - "base": "

The media capabilities of an attendee: audio, video, or content.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", + "base": "

The media capabilities of an attendee: audio, video, or content.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", "refs": { - "Attendee$Capabilities": "

The capabilities assigned to an attendee: audio, video, or content.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", + "Attendee$Capabilities": "

The capabilities assigned to an attendee: audio, video, or content.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", "BatchUpdateAttendeeCapabilitiesExceptRequest$Capabilities": "

The capabilities (audio, video, or content) that you want to update.

", - "CreateAttendeeRequest$Capabilities": "

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", + "CreateAttendeeRequest$Capabilities": "

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

", "CreateAttendeeRequestItem$Capabilities": "

A list of one or more capabilities.

", - "UpdateAttendeeCapabilitiesRequest$Capabilities": "

The capabilties that you want to update.

" + "UpdateAttendeeCapabilitiesRequest$Capabilities": "

The capabilities that you want to update.

" } }, "AttendeeIdItem": { @@ -114,8 +114,8 @@ "Boolean": { "base": null, "refs": { - "EngineTranscribeSettings$EnablePartialResultsStabilization": "

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

", - "EngineTranscribeSettings$IdentifyLanguage": "

Automatically identifies the language spoken in media files.

" + "EngineTranscribeSettings$EnablePartialResultsStabilization": "

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.

", + "EngineTranscribeSettings$IdentifyLanguage": "

Enables automatic language identification for your transcription.

If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.

You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.

You must include either LanguageCode or IdentifyLanguage.

Language identification can't be combined with custom language models or redaction.

" } }, "ClientRequestToken": { @@ -202,7 +202,7 @@ } }, "EngineTranscribeSettings": { - "base": "

Settings specific to the Amazon Transcribe engine.

", + "base": "

Settings specific for Amazon Transcribe as the live transcription engine.

If you specify an invalid combination of parameters, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

", "refs": { "TranscriptionConfiguration$EngineTranscribeSettings": "

The transcription configuration settings passed to Amazon Transcribe.

" } @@ -418,8 +418,8 @@ "CreateAttendeeError$ErrorCode": "

The error code.

", "CreateAttendeeError$ErrorMessage": "

The error message.

", "EngineTranscribeMedicalSettings$VocabularyName": "

The name of the vocabulary passed to Amazon Transcribe Medical.

", - "EngineTranscribeSettings$VocabularyFilterName": "

The name of the vocabulary filter passed to Amazon Transcribe.

", - "EngineTranscribeSettings$VocabularyName": "

The name of the vocabulary passed to Amazon Transcribe.

", + "EngineTranscribeSettings$VocabularyFilterName": "

Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

", + "EngineTranscribeSettings$VocabularyName": "

Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

", "ForbiddenException$Code": null, "ForbiddenException$Message": null, "ForbiddenException$RequestId": "

The request id associated with the call responsible for the exception.

", @@ -533,32 +533,32 @@ "TranscribeContentIdentificationType": { "base": null, "refs": { - "EngineTranscribeSettings$ContentIdentificationType": "

Set this field to PII to identify personally identifiable information in the transcription output.

" + "EngineTranscribeSettings$ContentIdentificationType": "

Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

You can’t set ContentIdentificationType and ContentRedactionType.

" } }, "TranscribeContentRedactionType": { "base": null, "refs": { - "EngineTranscribeSettings$ContentRedactionType": "

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

" + "EngineTranscribeSettings$ContentRedactionType": "

Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

You can’t set ContentRedactionType and ContentIdentificationType.

" } }, "TranscribeLanguageCode": { "base": null, "refs": { - "EngineTranscribeSettings$LanguageCode": "

The language code specified for the Amazon Transcribe engine.

", - "EngineTranscribeSettings$PreferredLanguage": "

Language code for the preferred language.

" + "EngineTranscribeSettings$LanguageCode": "

Specify the language code that represents the language spoken.

If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

", + "EngineTranscribeSettings$PreferredLanguage": "

Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

You can only use this parameter if you include IdentifyLanguage and LanguageOptions.

" } }, "TranscribeLanguageModelName": { "base": null, "refs": { - "EngineTranscribeSettings$LanguageModelName": "

The name of the language model used during transcription.

" + "EngineTranscribeSettings$LanguageModelName": "

Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.

" } }, "TranscribeLanguageOptions": { "base": null, "refs": { - "EngineTranscribeSettings$LanguageOptions": "

Language codes for the languages that you want to identify. You must provide at least 2 codes.

" + "EngineTranscribeSettings$LanguageOptions": "

Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

If you include LanguageOptions, you must also include IdentifyLanguage.

You can only include one language dialect per language. For example, you cannot include en-US and en-AU.

" } }, "TranscribeMedicalContentIdentificationType": { @@ -594,25 +594,32 @@ "TranscribePartialResultsStability": { "base": null, "refs": { - "EngineTranscribeSettings$PartialResultsStability": "

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

" + "EngineTranscribeSettings$PartialResultsStability": "

Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

" } }, "TranscribePiiEntityTypes": { "base": null, "refs": { - "EngineTranscribeSettings$PiiEntityTypes": "

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

" + "EngineTranscribeSettings$PiiEntityTypes": "

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL,NAME, PHONE, PIN, SSN, or ALL.

Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.

If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.

" } }, "TranscribeRegion": { "base": null, "refs": { - "EngineTranscribeSettings$Region": "

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

" + "EngineTranscribeSettings$Region": "

The AWS Region in which to use Amazon Transcribe.

If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

" } }, "TranscribeVocabularyFilterMethod": { "base": null, "refs": { - "EngineTranscribeSettings$VocabularyFilterMethod": "

The filtering method passed to Amazon Transcribe.

" + "EngineTranscribeSettings$VocabularyFilterMethod": "

Specify how you want your vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

" + } + }, + "TranscribeVocabularyNamesOrFilterNamesString": { + "base": null, + "refs": { + "EngineTranscribeSettings$VocabularyNames": "

Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

", + "EngineTranscribeSettings$VocabularyFilterNames": "

Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

" } }, "TranscriptionConfiguration": { diff --git a/models/apis/chime-sdk-meetings/2021-07-15/endpoint-rule-set-1.json b/models/apis/chime-sdk-meetings/2021-07-15/endpoint-rule-set-1.json index 76b5f77525..ba8bb30e19 100644 --- a/models/apis/chime-sdk-meetings/2021-07-15/endpoint-rule-set-1.json +++ b/models/apis/chime-sdk-meetings/2021-07-15/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,154 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://meetings-chime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -286,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://meetings-chime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://meetings-chime.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -295,28 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://meetings-chime.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/chime-sdk-meetings/2021-07-15/endpoint-tests-1.json b/models/apis/chime-sdk-meetings/2021-07-15/endpoint-tests-1.json index 5a5cc8c7d7..544718aa36 100644 --- a/models/apis/chime-sdk-meetings/2021-07-15/endpoint-tests-1.json +++ b/models/apis/chime-sdk-meetings/2021-07-15/endpoint-tests-1.json @@ -9,8 +9,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -22,8 +22,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -35,8 +35,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -48,8 +48,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -61,8 +61,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -74,8 +74,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -87,8 +87,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -100,8 +100,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -113,8 +113,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -126,8 +126,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -139,8 +139,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -152,8 +152,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -165,8 +165,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -178,8 +178,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -191,8 +191,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -204,8 +204,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -217,8 +217,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -230,8 +230,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -243,8 +254,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -256,8 +278,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -269,8 +302,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -282,12 +326,12 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -295,8 +339,21 @@ }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -307,8 +364,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -319,10 +376,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/chime/2018-05-01/api-2.json b/models/apis/chime/2018-05-01/api-2.json index 563aa6bb97..a8d830fb9e 100644 --- a/models/apis/chime/2018-05-01/api-2.json +++ b/models/apis/chime/2018-05-01/api-2.json @@ -5926,7 +5926,6 @@ }, "EngineTranscribeSettings":{ "type":"structure", - "required":["LanguageCode"], "members":{ "LanguageCode":{"shape":"TranscribeLanguageCode"}, "VocabularyFilterMethod":{"shape":"TranscribeVocabularyFilterMethod"}, @@ -5938,7 +5937,12 @@ "ContentIdentificationType":{"shape":"TranscribeContentIdentificationType"}, "ContentRedactionType":{"shape":"TranscribeContentRedactionType"}, "PiiEntityTypes":{"shape":"TranscribePiiEntityTypes"}, - "LanguageModelName":{"shape":"TranscribeLanguageModelName"} + "LanguageModelName":{"shape":"TranscribeLanguageModelName"}, + "IdentifyLanguage":{"shape":"Boolean"}, + "LanguageOptions":{"shape":"TranscribeLanguageOptions"}, + "PreferredLanguage":{"shape":"TranscribeLanguageCode"}, + "VocabularyNames":{"shape":"TranscribeVocabularyNamesOrFilterNamesString"}, + "VocabularyFilterNames":{"shape":"TranscribeVocabularyNamesOrFilterNamesString"} } }, "ErrorCode":{ @@ -9038,7 +9042,9 @@ "pt-BR", "ja-JP", "ko-KR", - "zh-CN" + "zh-CN", + "th-TH", + "hi-IN" ] }, "TranscribeLanguageModelName":{ @@ -9047,6 +9053,12 @@ "min":1, "pattern":"^[0-9a-zA-Z._-]+" }, + "TranscribeLanguageOptions":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[a-zA-Z-,]+" + }, "TranscribeMedicalContentIdentificationType":{ "type":"string", "enum":["PHI"] @@ -9124,6 +9136,12 @@ "tag" ] }, + "TranscribeVocabularyNamesOrFilterNamesString":{ + "type":"string", + "max":3000, + "min":1, + "pattern":"^[a-zA-Z0-9,-._]+" + }, "TranscriptionConfiguration":{ "type":"structure", "members":{ diff --git a/models/apis/chime/2018-05-01/docs-2.json b/models/apis/chime/2018-05-01/docs-2.json index 605d3d5b90..449d390db0 100644 --- a/models/apis/chime/2018-05-01/docs-2.json +++ b/models/apis/chime/2018-05-01/docs-2.json @@ -1,12 +1,12 @@ { "version": "2.0", - "service": "

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes API actions for use with the Amazon Chime SDK, which developers use to build their own communication applications. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

", + "service": "

The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

", "operations": { "AssociatePhoneNumberWithUser": "

Associates a phone number with the specified Amazon Chime user.

", "AssociatePhoneNumbersWithVoiceConnector": "

Associates phone numbers with the specified Amazon Chime Voice Connector.

", "AssociatePhoneNumbersWithVoiceConnectorGroup": "

Associates phone numbers with the specified Amazon Chime Voice Connector group.

", "AssociateSigninDelegateGroupsWithAccount": "

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

", - "BatchCreateAttendee": "

Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", + "BatchCreateAttendee": "

Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

", "BatchCreateChannelMembership": "

Adds a specified number of users to a channel.

", "BatchCreateRoomMembership": "

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

", "BatchDeletePhoneNumber": "

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

", @@ -18,16 +18,16 @@ "CreateAppInstance": "

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

", "CreateAppInstanceAdmin": "

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

", "CreateAppInstanceUser": "

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

", - "CreateAttendee": "

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", + "CreateAttendee": "

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

", "CreateBot": "

Creates a bot for an Amazon Chime Enterprise account.

", "CreateChannel": "

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "CreateChannelBan": "

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "CreateChannelMembership": "

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

Privacy settings impact this action as follows:

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "CreateChannelModerator": "

Creates a new ChannelModerator. A channel moderator can:

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "CreateMediaCapturePipeline": "

Creates a media capture pipeline.

", - "CreateMeeting": "

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

", + "CreateMeeting": "

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

", "CreateMeetingDialOut": "

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

", - "CreateMeetingWithAttendees": "

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

", + "CreateMeetingWithAttendees": "

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

", "CreatePhoneNumberOrder": "

Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

", "CreateProxySession": "

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

", "CreateRoom": "

Creates a chat room for the specified Amazon Chime Enterprise account.

", @@ -43,7 +43,7 @@ "DeleteAppInstanceAdmin": "

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

", "DeleteAppInstanceStreamingConfigurations": "

Deletes the streaming configurations of an AppInstance.

", "DeleteAppInstanceUser": "

Deletes an AppInstanceUser.

", - "DeleteAttendee": "

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", + "DeleteAttendee": "

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

", "DeleteChannel": "

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "DeleteChannelBan": "

Removes a user from a channel's ban list.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "DeleteChannelMembership": "

Removes a member from a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", @@ -51,7 +51,7 @@ "DeleteChannelModerator": "

Deletes a channel moderator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "DeleteEventsConfiguration": "

Deletes the events configuration that allows a bot to receive outgoing events.

", "DeleteMediaCapturePipeline": "

Deletes the media capture pipeline.

", - "DeleteMeeting": "

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", + "DeleteMeeting": "

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

", "DeletePhoneNumber": "

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

", "DeleteProxySession": "

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

", "DeleteRoom": "

Deletes a chat room in an Amazon Chime Enterprise account.

", @@ -83,13 +83,13 @@ "GetAccountSettings": "

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

", "GetAppInstanceRetentionSettings": "

Gets the retention settings for an AppInstance.

", "GetAppInstanceStreamingConfigurations": "

Gets the streaming settings for an AppInstance.

", - "GetAttendee": "

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

", + "GetAttendee": "

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

", "GetBot": "

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

", "GetChannelMessage": "

Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "GetEventsConfiguration": "

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

", "GetGlobalSettings": "

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

", "GetMediaCapturePipeline": "

Gets an existing media capture pipeline.

", - "GetMeeting": "

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

", + "GetMeeting": "

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

", "GetMessagingSessionEndpoint": "

The details of the endpoint for the messaging session.

", "GetPhoneNumber": "

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

", "GetPhoneNumberOrder": "

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

", @@ -117,7 +117,7 @@ "ListAppInstanceUsers": "

List all AppInstanceUsers created under a single AppInstance.

", "ListAppInstances": "

Lists all Amazon Chime AppInstances created under a single AWS account.

", "ListAttendeeTags": "

Lists the tags applied to an Amazon Chime SDK attendee resource.

", - "ListAttendees": "

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", + "ListAttendees": "

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

", "ListBots": "

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

", "ListChannelBans": "

Lists all the users banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "ListChannelMemberships": "

Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", @@ -128,7 +128,7 @@ "ListChannelsModeratedByAppInstanceUser": "

A list of the channels moderated by an AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

", "ListMediaCapturePipelines": "

Returns a list of media capture pipelines.

", "ListMeetingTags": "

Lists the tags applied to an Amazon Chime SDK meeting resource.

", - "ListMeetings": "

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", + "ListMeetings": "

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

", "ListPhoneNumberOrders": "

Lists the phone number orders for the administrator's Amazon Chime account.

", "ListPhoneNumbers": "

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

", "ListProxySessions": "

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

", @@ -163,7 +163,7 @@ "RestorePhoneNumber": "

Moves a phone number from the Deletion queue back into the phone number Inventory.

", "SearchAvailablePhoneNumbers": "

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

", "SendChannelMessage": "

Sends a message to a particular channel that the member is a part of.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

", - "StartMeetingTranscription": "

Starts transcription for the specified meetingId.

", + "StartMeetingTranscription": "

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

", "StopMeetingTranscription": "

Stops transcription for the specified meetingId.

", "TagAttendee": "

Applies the specified tags to the specified Amazon Chime SDK attendee.

", "TagMeeting": "

Applies the specified tags to the specified Amazon Chime SDK meeting.

", @@ -344,7 +344,7 @@ "AppInstanceUserMembershipSummary": { "base": "

Summary of the membership details of an AppInstanceUser.

", "refs": { - "ChannelMembershipForAppInstanceUserSummary$AppInstanceUserMembershipSummary": null + "ChannelMembershipForAppInstanceUserSummary$AppInstanceUserMembershipSummary": "

Summary of the membership details of an AppInstanceUser.

" } }, "AppInstanceUserSummary": { @@ -592,9 +592,10 @@ "AccountSettings$EnableDialOut": "

Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

", "AlexaForBusinessMetadata$IsAlexaForBusinessEnabled": "

Starts or stops Alexa for Business.

", "CreateVoiceConnectorRequest$RequireEncryption": "

When enabled, requires encryption for the Amazon Chime Voice Connector.

", - "EngineTranscribeSettings$EnablePartialResultsStabilization": "

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

", - "LoggingConfiguration$EnableSIPLogs": "

When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

", - "LoggingConfiguration$EnableMediaMetricLogs": "

Boolean that enables the logging of Voice Connector metrics to Cloudwatch.

", + "EngineTranscribeSettings$EnablePartialResultsStabilization": "

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.

", + "EngineTranscribeSettings$IdentifyLanguage": "

Enables automatic language identification for your transcription.

If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.

You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.

You must include either LanguageCode or IdentifyLanguage.

Language identification can't be combined with custom language models or redaction.

", + "LoggingConfiguration$EnableSIPLogs": "

Boolean that enables SIP message logs to Amazon CloudWatch logs.

", + "LoggingConfiguration$EnableMediaMetricLogs": "

Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.

", "Origination$Disabled": "

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

", "Proxy$Disabled": "

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

", "PutVoiceConnectorProxyRequest$Disabled": "

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

", @@ -615,7 +616,7 @@ "BotList$member": null, "CreateBotResponse$Bot": "

The bot details.

", "GetBotResponse$Bot": "

The chat bot details.

", - "RegenerateSecurityTokenResponse$Bot": null, + "RegenerateSecurityTokenResponse$Bot": "

A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.

", "UpdateBotResponse$Bot": "

The updated bot details.

" } }, @@ -732,7 +733,7 @@ "ChannelMembershipForAppInstanceUserSummaryList": { "base": null, "refs": { - "ListChannelMembershipsForAppInstanceUserResponse$ChannelMemberships": "

The token passed by previous API calls until all requested users are returned.

" + "ListChannelMembershipsForAppInstanceUserResponse$ChannelMemberships": "

The information for the requested channel memberships.

" } }, "ChannelMembershipSummary": { @@ -849,7 +850,7 @@ "ChannelSummary": { "base": "

Summary of the details of a Channel.

", "refs": { - "ChannelMembershipForAppInstanceUserSummary$ChannelSummary": null, + "ChannelMembershipForAppInstanceUserSummary$ChannelSummary": "

Summary of the details of a Channel.

", "ChannelModeratedByAppInstanceUserSummary$ChannelSummary": "

Summary of the details of a Channel.

", "ChannelSummaryList$member": null } @@ -1002,7 +1003,7 @@ "CreateAppInstanceRequest$ClientRequestToken": "

The ClientRequestToken of the AppInstance.

", "CreateAppInstanceUserRequest$ClientRequestToken": "

The token assigned to the user requesting an AppInstance.

", "CreateChannelRequest$ClientRequestToken": "

The client token for the request. An Idempotency token.

", - "CreateMediaCapturePipelineRequest$ClientRequestToken": "

The token assigned to the client making the pipeline request.

", + "CreateMediaCapturePipelineRequest$ClientRequestToken": "

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

", "CreateMeetingRequest$ClientRequestToken": "

The unique identifier for the client request. Use a different token for different meetings.

", "CreateMeetingWithAttendeesRequest$ClientRequestToken": "

The unique identifier for the client request. Use a different token for different meetings.

", "CreateRoomRequest$ClientRequestToken": "

The idempotency token for the request.

", @@ -1693,7 +1694,7 @@ } }, "EngineTranscribeSettings": { - "base": "

Settings specific to the Amazon Transcribe engine.

", + "base": "

Settings specific for Amazon Transcribe as the live transcription engine.

If you specify an invalid combination of parameters, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

", "refs": { "TranscriptionConfiguration$EngineTranscribeSettings": "

The transcription configuration settings passed to Amazon Transcribe.

" } @@ -1722,7 +1723,7 @@ "base": "

The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

", "refs": { "GetEventsConfigurationResponse$EventsConfiguration": "

The events configuration details.

", - "PutEventsConfigurationResponse$EventsConfiguration": null + "PutEventsConfigurationResponse$EventsConfiguration": "

The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an AWS Lambda function ARN.

" } }, "ExternalMeetingIdType": { @@ -1759,7 +1760,7 @@ "FunctionArn": { "base": null, "refs": { - "SipMediaApplicationEndpoint$LambdaArn": "

Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.

" + "SipMediaApplicationEndpoint$LambdaArn": "

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

" } }, "GeoMatchLevel": { @@ -2620,7 +2621,7 @@ "base": "

A meeting created using the Amazon Chime SDK.

", "refs": { "CreateMeetingResponse$Meeting": "

The meeting information, including the meeting ID and MediaPlacement .

", - "CreateMeetingWithAttendeesResponse$Meeting": null, + "CreateMeetingWithAttendeesResponse$Meeting": "

A meeting created using the Amazon Chime SDK.

", "GetMeetingResponse$Meeting": "

The Amazon Chime SDK meeting information.

", "MeetingList$member": null } @@ -2635,7 +2636,7 @@ "base": "

The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).

", "refs": { "CreateMeetingRequest$NotificationsConfiguration": "

The configuration for resource targets to receive notifications when meeting and attendee events occur.

", - "CreateMeetingWithAttendeesRequest$NotificationsConfiguration": null + "CreateMeetingWithAttendeesRequest$NotificationsConfiguration": "

The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).

" } }, "MeetingTagKeyList": { @@ -2655,7 +2656,7 @@ "Member": { "base": "

The member details, such as email address, name, member ID, and member type.

", "refs": { - "RoomMembership$Member": null + "RoomMembership$Member": "

The member details, such as email address, name, member ID, and member type.

" } }, "MemberArns": { @@ -3671,7 +3672,7 @@ "base": "

A Call instance for a SIP media application.

", "refs": { "CreateSipMediaApplicationCallResponse$SipMediaApplicationCall": "

The actual call.

", - "UpdateSipMediaApplicationCallResponse$SipMediaApplicationCall": null + "UpdateSipMediaApplicationCallResponse$SipMediaApplicationCall": "

A Call instance for a SIP media application.

" } }, "SipMediaApplicationEndpoint": { @@ -3699,7 +3700,7 @@ "refs": { "GetSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": "

The actual logging configuration.

", "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationLoggingConfiguration": "

The actual logging configuration.

", - "PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": null + "PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": "

The logging configuration of the SIP media application.

" } }, "SipMediaApplicationName": { @@ -3763,7 +3764,7 @@ "SourceConfiguration": { "base": "

Source configuration for a specified media capture pipeline.

", "refs": { - "ChimeSdkMeetingConfiguration$SourceConfiguration": "

The source configuration for a specified media capture pipline.

" + "ChimeSdkMeetingConfiguration$SourceConfiguration": "

The source configuration for a specified media capture pipeline.

" } }, "StartMeetingTranscriptionRequest": { @@ -3831,8 +3832,8 @@ "DisassociatePhoneNumberFromUserRequest$AccountId": "

The Amazon Chime account ID.

", "DisassociatePhoneNumberFromUserRequest$UserId": "

The user ID.

", "EngineTranscribeMedicalSettings$VocabularyName": "

The name of the vocabulary passed to Amazon Transcribe Medical.

", - "EngineTranscribeSettings$VocabularyFilterName": "

The name of the vocabulary filter passed to Amazon Transcribe.

", - "EngineTranscribeSettings$VocabularyName": "

The name of the vocabulary passed to Amazon Transcribe.

", + "EngineTranscribeSettings$VocabularyFilterName": "

Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

", + "EngineTranscribeSettings$VocabularyName": "

Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

", "EventsConfiguration$BotId": "

The bot ID.

", "ForbiddenException$Message": null, "GetPhoneNumberRequest$PhoneNumberId": "

The phone number ID.

", @@ -4032,31 +4033,38 @@ "TranscribeContentIdentificationType": { "base": null, "refs": { - "EngineTranscribeSettings$ContentIdentificationType": "

Set this field to PII to identify personally identifiable information in the transcription output.

" + "EngineTranscribeSettings$ContentIdentificationType": "

Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

You can’t set ContentIdentificationType and ContentRedactionType.

" } }, "TranscribeContentRedactionType": { "base": null, "refs": { - "EngineTranscribeSettings$ContentRedactionType": "

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

" + "EngineTranscribeSettings$ContentRedactionType": "

Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

You can’t set ContentIdentificationType and ContentRedactionType.

" } }, "TranscribeLanguageCode": { "base": null, "refs": { - "EngineTranscribeSettings$LanguageCode": "

The language code specified for the Amazon Transcribe engine.

" + "EngineTranscribeSettings$LanguageCode": "

Specify the language code that represents the language spoken.

If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

", + "EngineTranscribeSettings$PreferredLanguage": "

Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

You can only use this parameter if you include IdentifyLanguage and LanguageOptions.

" } }, "TranscribeLanguageModelName": { "base": null, "refs": { - "EngineTranscribeSettings$LanguageModelName": "

The name of the language model used during transcription.

" + "EngineTranscribeSettings$LanguageModelName": "

Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.

" + } + }, + "TranscribeLanguageOptions": { + "base": null, + "refs": { + "EngineTranscribeSettings$LanguageOptions": "

Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

If you include LanguageOptions, you must also include IdentifyLanguage.

You can only include one language dialect per language. For example, you cannot include en-US and en-AU.

" } }, "TranscribeMedicalContentIdentificationType": { "base": null, "refs": { - "EngineTranscribeMedicalSettings$ContentIdentificationType": "

Set this field to PHI to identify personal health information in the transcription output.

" + "EngineTranscribeMedicalSettings$ContentIdentificationType": "

Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

You can’t set ContentIdentificationType and ContentRedactionType.

" } }, "TranscribeMedicalLanguageCode": { @@ -4086,25 +4094,32 @@ "TranscribePartialResultsStability": { "base": null, "refs": { - "EngineTranscribeSettings$PartialResultsStability": "

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

" + "EngineTranscribeSettings$PartialResultsStability": "

Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

" } }, "TranscribePiiEntityTypes": { "base": null, "refs": { - "EngineTranscribeSettings$PiiEntityTypes": "

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

" + "EngineTranscribeSettings$PiiEntityTypes": "

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL,NAME, PHONE, PIN, SSN, or ALL.

Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.

If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.

" } }, "TranscribeRegion": { "base": null, "refs": { - "EngineTranscribeSettings$Region": "

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

" + "EngineTranscribeSettings$Region": "

The AWS Region in which to use Amazon Transcribe.

If you don't specify a Region, then the MediaRegion parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

" } }, "TranscribeVocabularyFilterMethod": { "base": null, "refs": { - "EngineTranscribeSettings$VocabularyFilterMethod": "

The filtering method passed to Amazon Transcribe.

" + "EngineTranscribeSettings$VocabularyFilterMethod": "

Specify how you want your vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

" + } + }, + "TranscribeVocabularyNamesOrFilterNamesString": { + "base": null, + "refs": { + "EngineTranscribeSettings$VocabularyNames": "

Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

", + "EngineTranscribeSettings$VocabularyFilterNames": "

Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

" } }, "TranscriptionConfiguration": { @@ -4379,7 +4394,7 @@ "User": { "base": "

The user on the Amazon Chime account.

", "refs": { - "CreateUserResponse$User": null, + "CreateUserResponse$User": "

The user on the Amazon Chime account.

", "GetUserResponse$User": "

The user details.

", "ResetPersonalPINResponse$User": "

The user details and new personal meeting PIN.

", "UpdateUserResponse$User": "

The updated user details.

", diff --git a/models/apis/chime/2018-05-01/endpoint-rule-set-1.json b/models/apis/chime/2018-05-01/endpoint-rule-set-1.json new file mode 100644 index 0000000000..21fb8405a1 --- /dev/null +++ b/models/apis/chime/2018-05-01/endpoint-rule-set-1.json @@ -0,0 +1,401 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://chime.us-east-1.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "chime", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/chime/2018-05-01/endpoint-tests-1.json b/models/apis/chime/2018-05-01/endpoint-tests-1.json new file mode 100644 index 0000000000..cbcf32f659 --- /dev/null +++ b/models/apis/chime/2018-05-01/endpoint-tests-1.json @@ -0,0 +1,345 @@ +{ + "testCases": [ + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "chime", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://chime.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chime.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "chime", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://chime.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chime.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chime.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chime.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/gamelift/2015-10-01/api-2.json b/models/apis/gamelift/2015-10-01/api-2.json index 63459bfa41..c526720c02 100644 --- a/models/apis/gamelift/2015-10-01/api-2.json +++ b/models/apis/gamelift/2015-10-01/api-2.json @@ -111,7 +111,8 @@ {"shape":"NotFoundException"}, {"shape":"InvalidFleetStatusException"}, {"shape":"UnsupportedRegionException"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"} ] }, "CreateGameServerGroup":{ @@ -4366,7 +4367,8 @@ "enum":[ "WINDOWS_2012", "AMAZON_LINUX", - "AMAZON_LINUX_2" + "AMAZON_LINUX_2", + "WINDOWS_2016" ] }, "OutOfCapacityException":{ diff --git a/models/apis/gamelift/2015-10-01/docs-2.json b/models/apis/gamelift/2015-10-01/docs-2.json index 82841d5f0a..d0299876ed 100644 --- a/models/apis/gamelift/2015-10-01/docs-2.json +++ b/models/apis/gamelift/2015-10-01/docs-2.json @@ -1,54 +1,54 @@ { "version": "2.0", - "service": "

Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.

About GameLift solutions

Get more information on these GameLift solutions in the GameLift Developer Guide.

About this API Reference

This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:

", + "service": "

Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.

About Amazon GameLift solutions

Get more information on these Amazon GameLift solutions in the Amazon GameLift Developer Guide.

About this API Reference

This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:

", "operations": { "AcceptMatch": "

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

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

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

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

Learn more

Add FlexMatch to a game client

FlexMatch events (reference)

", - "ClaimGameServer": "

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

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

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

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

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

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

Learn more

GameLift FleetIQ Guide

", + "ClaimGameServer": "

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

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

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

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

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

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

Learn more

Amazon GameLift FleetIQ Guide

", "CreateAlias": "

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

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

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

Related actions

All APIs by task

", - "CreateBuild": "

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

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

You can use the operation in the following scenarios:

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

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

All APIs by task

", - "CreateFleet": "

Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.

Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.

To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.

If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.

If successful, this operation creates a new Fleet resource and places it in NEW status, which prompts GameLift to initiate the fleet creation workflow.

Learn more

Setting up fleets

Debug fleet creation issues

Multi-location fleets

", - "CreateFleetLocations": "

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

This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature and were created after the feature was released in March 2021.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.

Learn more

Setting up fleets

Multi-location fleets

", - "CreateGameServerGroup": "

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

Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following:

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

Learn more

GameLift FleetIQ Guide

", - "CreateGameSession": "

Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with StartGameSessionPlacement , which uses FleetIQ algorithms and queues to optimize the placement process.

When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in ACTIVE status before a game session can be created in it.

This operation can be used in the following ways:

If successful, a workflow is initiated to start a new game session. A GameSession object is returned containing the game session configuration and status. When the status is ACTIVE, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Game session logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

Learn more

Start a game session

All APIs by task

", - "CreateGameSessionQueue": "

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

", + "CreateBuild": "

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

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

You can use the operation in the following scenarios:

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

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

All APIs by task

", + "CreateFleet": "

Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.

Most Amazon GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other Amazon GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.

To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct Amazon GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.

If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.

If successful, this operation creates a new Fleet resource and places it in NEW status, which prompts Amazon GameLift to initiate the fleet creation workflow.

Learn more

Setting up fleets

Debug fleet creation issues

Multi-location fleets

", + "CreateFleetLocations": "

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

This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature and were created after the feature was released in March 2021.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.

Learn more

Setting up fleets

Multi-location fleets

", + "CreateGameServerGroup": "

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

Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following:

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

Learn more

Amazon GameLift FleetIQ Guide

", + "CreateGameSession": "

Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement , which uses FleetIQ algorithms and queues to optimize the placement process.

When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in ACTIVE status before a game session can be created in it.

This operation can be used in the following ways:

If successful, a workflow is initiated to start a new game session. A GameSession object is returned containing the game session configuration and status. When the status is ACTIVE, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Game session logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

Learn more

Start a game session

All APIs by task

", + "CreateGameSessionQueue": "

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

", "CreateLocation": "

Creates a custom location for use in an Anywhere fleet.

", - "CreateMatchmakingConfiguration": "

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.

Learn more

Design a FlexMatch matchmaker

Set up FlexMatch event notification

", + "CreateMatchmakingConfiguration": "

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.

Learn more

Design a FlexMatch matchmaker

Set up FlexMatch event notification

", "CreateMatchmakingRuleSet": "

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

", - "CreatePlayerSession": "

Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions .

To create a player session, specify a game session ID, player ID, and optionally a set of player data.

If successful, a slot is reserved in the game session for the player and a new PlayerSessions object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

", - "CreatePlayerSessions": "

Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession

To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

", + "CreatePlayerSession": "

Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions .

To create a player session, specify a game session ID, player ID, and optionally a set of player data.

If successful, a slot is reserved in the game session for the player and a new PlayerSessions object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

", + "CreatePlayerSessions": "

Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession

To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

", "CreateScript": "

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:

If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

Learn more

Amazon GameLift Realtime Servers

Set Up a Role for Amazon GameLift Access

Related actions

All APIs by task

", "CreateVpcPeeringAuthorization": "

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.

To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.

Related actions

All APIs by task

", "CreateVpcPeeringConnection": "

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents .

Related actions

All APIs by task

", "DeleteAlias": "

Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

Related actions

All APIs by task

", "DeleteBuild": "

Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

To delete a build, specify the build ID.

Learn more

Upload a Custom Server Build

All APIs by task

", - "DeleteFleet": "

Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call DeleteFleetLocations separately.

If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection.

To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is sent.

Learn more

Setting up GameLift Fleets

", - "DeleteFleetLocations": "

Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.

To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.

If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.

Learn more

Setting up GameLift fleets

", - "DeleteGameServerGroup": "

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

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

GameLift FleetIQ Guide

", + "DeleteFleet": "

Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call DeleteFleetLocations separately.

If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection.

To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is sent.

Learn more

Setting up Amazon GameLift Fleets

", + "DeleteFleetLocations": "

Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.

To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.

If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.

Learn more

Setting up Amazon GameLift fleets

", + "DeleteGameServerGroup": "

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

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

Amazon GameLift FleetIQ Guide

", "DeleteGameSessionQueue": "

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.

", "DeleteLocation": "

Deletes a custom location.

Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information see, DeregisterCompute.

", "DeleteMatchmakingConfiguration": "

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

", "DeleteMatchmakingRuleSet": "

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

", - "DeleteScalingPolicy": "

Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.

", + "DeleteScalingPolicy": "

Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.

", "DeleteScript": "

Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).

To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

", "DeleteVpcPeeringAuthorization": "

Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.

Related actions

All APIs by task

", "DeleteVpcPeeringConnection": "

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete..

Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

Related actions

All APIs by task

", "DeregisterCompute": "

Removes a compute resource from the specified fleet. Deregister your compute resources before you delete the compute.

", - "DeregisterGameServer": "

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

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

GameLift FleetIQ Guide

", + "DeregisterGameServer": "

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

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

Amazon GameLift FleetIQ Guide

", "DescribeAlias": "

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

Related actions

All APIs by task

", "DescribeBuild": "

Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.

Learn more

Upload a Custom Server Build

All APIs by task

", - "DescribeCompute": "

Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, GameLift returns an object containing the build properties.

", - "DescribeEC2InstanceLimits": "

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.

Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:

This operation can be used in the following ways:

If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.

Learn more

Setting up GameLift fleets

", - "DescribeFleetAttributes": "

Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.

This operation can be used in the following ways:

When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.

Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.

Learn more

Setting up GameLift fleets

", - "DescribeFleetCapacity": "

Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.

This operation can be used in the following ways:

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.

Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

", - "DescribeFleetEvents": "

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.

You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a collection of event log entries matching the request are returned.

Learn more

Setting up GameLift fleets

", - "DescribeFleetLocationAttributes": "

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

This operation can be used in the following ways:

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up GameLift fleets

", - "DescribeFleetLocationCapacity": "

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

", - "DescribeFleetLocationUtilization": "

Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).

To retrieve utilization data, identify a fleet and location.

If successful, a FleetUtilization object is returned for the requested fleet location.

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

", - "DescribeFleetPortSettings": "

Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.

This operation can be used in the following ways:

If successful, a set of IpPermission objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift fleets

", - "DescribeFleetUtilization": "

Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.

This operation can be used in the following ways:

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region.

Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Setting up GameLift Fleets

GameLift Metrics for Fleets

", - "DescribeGameServer": "

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

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

GameLift FleetIQ Guide

", - "DescribeGameServerGroup": "

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

Retrieves information on a game server group. This operation returns only properties related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

GameLift FleetIQ Guide

", - "DescribeGameServerInstances": "

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

Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.

To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.

This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.

Learn more

GameLift FleetIQ Guide

", + "DescribeCompute": "

Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, Amazon GameLift returns an object containing the build properties.

", + "DescribeEC2InstanceLimits": "

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.

Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:

This operation can be used in the following ways:

If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.

Learn more

Setting up Amazon GameLift fleets

", + "DescribeFleetAttributes": "

Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.

This operation can be used in the following ways:

When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.

Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.

Learn more

Setting up Amazon GameLift fleets

", + "DescribeFleetCapacity": "

Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.

This operation can be used in the following ways:

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.

Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

", + "DescribeFleetEvents": "

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.

You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a collection of event log entries matching the request are returned.

Learn more

Setting up Amazon GameLift fleets

", + "DescribeFleetLocationAttributes": "

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

This operation can be used in the following ways:

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up Amazon GameLift fleets

", + "DescribeFleetLocationCapacity": "

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

", + "DescribeFleetLocationUtilization": "

Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).

To retrieve utilization data, identify a fleet and location.

If successful, a FleetUtilization object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

", + "DescribeFleetPortSettings": "

Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.

This operation can be used in the following ways:

If successful, a set of IpPermission objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets

", + "DescribeFleetUtilization": "

Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.

This operation can be used in the following ways:

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region.

Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Setting up Amazon GameLift Fleets

GameLift Metrics for Fleets

", + "DescribeGameServer": "

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

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

Amazon GameLift FleetIQ Guide

", + "DescribeGameServerGroup": "

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

Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide

", + "DescribeGameServerInstances": "

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

Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.

To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.

This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.

Learn more

Amazon GameLift FleetIQ Guide

", "DescribeGameSessionDetails": "

Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSessionDetail object is returned for each game session that matches the request.

Learn more

Find a game session

All APIs by task

", "DescribeGameSessionPlacement": "

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

", "DescribeGameSessionQueues": "

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.

Learn more

View Your Queues

", @@ -58,52 +58,52 @@ "DescribeMatchmakingConfigurations": "

Retrieves the details of FlexMatch matchmaking configurations.

This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Learn more

Setting up FlexMatch matchmakers

", "DescribeMatchmakingRuleSets": "

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

", "DescribePlayerSessions": "

Retrieves properties for one or more player sessions.

This action can be used in the following ways:

To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a PlayerSession object is returned for each session that matches the request.

Related actions

All APIs by task

", - "DescribeRuntimeConfiguration": "

Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.

To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID.

If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift fleets

Running multiple processes on a fleet

", + "DescribeRuntimeConfiguration": "

Retrieves a fleet's runtime configuration settings. The runtime configuration tells Amazon GameLift which server processes to run (and how) on each instance in the fleet.

To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID.

If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets

Running multiple processes on a fleet

", "DescribeScalingPolicies": "

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.

", "DescribeScript": "

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

", "DescribeVpcPeeringAuthorizations": "

Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

Related actions

All APIs by task

", "DescribeVpcPeeringConnections": "

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

Related actions

All APIs by task

", - "GetComputeAccess": "

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

", - "GetComputeAuthToken": "

Requests an authorization token from GameLift. The authorization token is used by your game server to authenticate with GameLift. Each authentication token has an expiration token. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.

", - "GetGameSessionLogUrl": "

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

All APIs by task

", - "GetInstanceAccess": "

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

All APIs by task

", + "GetComputeAccess": "

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

", + "GetComputeAuthToken": "

Requests an authentication token from Amazon GameLift. The authentication token is used by your game server to authenticate with Amazon GameLift. Each authentication token has an expiration time. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.

", + "GetGameSessionLogUrl": "

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

All APIs by task

", + "GetInstanceAccess": "

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

All APIs by task

", "ListAliases": "

Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Returned aliases are not listed in any particular order.

Related actions

All APIs by task

", "ListBuilds": "

Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build resources are not listed in any particular order.

Learn more

Upload a Custom Server Build

All APIs by task

", "ListCompute": "

Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.

", - "ListFleets": "

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

This operation can be used in the following ways:

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.

Fleet resources are not listed in a particular order.

Learn more

Setting up GameLift fleets

", + "ListFleets": "

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

This operation can be used in the following ways:

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.

Fleet resources are not listed in a particular order.

Learn more

Setting up Amazon GameLift fleets

", "ListGameServerGroups": "

Lists a game server groups.

", - "ListGameServers": "

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

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

GameLift FleetIQ Guide

", + "ListGameServers": "

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

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

Amazon GameLift FleetIQ Guide

", "ListLocations": "

Lists all custom and Amazon Web Services locations.

", "ListScripts": "

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

", - "ListTagsForResource": "

Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

To list tags for a resource, specify the unique ARN value for the resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", + "ListTagsForResource": "

Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To list tags for a resource, specify the unique ARN value for the resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", "PutScalingPolicy": "

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

", - "RegisterCompute": "

Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to GameLift.

Learn more

", - "RegisterGameServer": "

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

Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

GameLift FleetIQ Guide

", + "RegisterCompute": "

Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using Amazon GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to Amazon GameLift.

Learn more

", + "RegisterGameServer": "

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

Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

Amazon GameLift FleetIQ Guide

", "RequestUploadCredentials": "

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see GameSession.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more

Create a Build with Files in S3

All APIs by task

", "ResolveAlias": "

Retrieves the fleet ID that an alias is currently pointing to.

Related actions

All APIs by task

", - "ResumeGameServerGroup": "

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

Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.

To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.

Learn more

GameLift FleetIQ Guide

", + "ResumeGameServerGroup": "

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

Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.

To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.

Learn more

Amazon GameLift FleetIQ Guide

", "SearchGameSessions": "

Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling game session status with DescribeGameSessions should only be used for games in development with low game session usage.

When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.

This operation can be used in the following ways:

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .

You can search or sort by the following game session attributes:

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

All APIs by task

", - "StartFleetActions": "

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.

This operation can be used in the following ways:

If successful, GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.

Learn more

Setting up GameLift fleets

", + "StartFleetActions": "

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.

This operation can be used in the following ways:

If successful, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.

Learn more

Setting up Amazon GameLift fleets

", "StartGameSessionPlacement": "

Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

", - "StartMatchBackfill": "

Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.

When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSessions ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.

When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.

To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.

Only game sessions created by FlexMatch are supported for match backfill.

Learn more

Backfill existing games with FlexMatch

Matchmaking events (reference)

How GameLift FlexMatch works

", - "StartMatchmaking": "

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED.

Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

How GameLift FlexMatch works

", - "StopFleetActions": "

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.

Learn more

Setting up GameLift Fleets

", + "StartMatchBackfill": "

Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.

When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSessions ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.

When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.

To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.

Only game sessions created by FlexMatch are supported for match backfill.

Learn more

Backfill existing games with FlexMatch

Matchmaking events (reference)

How Amazon GameLift FlexMatch works

", + "StartMatchmaking": "

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED.

Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

How Amazon GameLift FlexMatch works

", + "StopFleetActions": "

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

If successful, Amazon GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.

Learn more

Setting up Amazon GameLift Fleets

", "StopGameSessionPlacement": "

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

", "StopMatchmaking": "

Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Add FlexMatch to a game client

", - "SuspendGameServerGroup": "

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

Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.

Learn more

GameLift FleetIQ Guide

", - "TagResource": "

Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", - "UntagResource": "

Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", + "SuspendGameServerGroup": "

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

Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.

Learn more

Amazon GameLift FleetIQ Guide

", + "TagResource": "

Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, and more. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", + "UntagResource": "

Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.

To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to remove. This operation succeeds even if the list includes tags that aren't assigned to the resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", "UpdateAlias": "

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

Related actions

All APIs by task

", "UpdateBuild": "

Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Learn more

Upload a Custom Server Build

All APIs by task

", - "UpdateFleetAttributes": "

Updates a fleet's mutable attributes, including game session protection and resource creation limits.

To update fleet attributes, specify the fleet ID and the property values that you want to change.

If successful, an updated FleetAttributes object is returned.

Learn more

Setting up GameLift fleets

", - "UpdateFleetCapacity": "

Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:

This operation can be used in the following ways:

If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs.

Learn more

Scaling fleet capacity

", - "UpdateFleetPortSettings": "

Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet.

To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.

If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name.

Learn more

Setting up GameLift fleets

", - "UpdateGameServer": "

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

Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group.

Use this operation to update the following types of game server information. You can make all three types of updates in the same request:

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

GameLift FleetIQ Guide

", - "UpdateGameServerGroup": "

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

Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.

To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

Learn more

GameLift FleetIQ Guide

", + "UpdateFleetAttributes": "

Updates a fleet's mutable attributes, including game session protection and resource creation limits.

To update fleet attributes, specify the fleet ID and the property values that you want to change.

If successful, an updated FleetAttributes object is returned.

Learn more

Setting up Amazon GameLift fleets

", + "UpdateFleetCapacity": "

Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:

This operation can be used in the following ways:

If successful, capacity settings are updated immediately. In response a change in desired capacity, Amazon GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs.

Learn more

Scaling fleet capacity

", + "UpdateFleetPortSettings": "

Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet.

To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.

If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name.

Learn more

Setting up Amazon GameLift fleets

", + "UpdateGameServer": "

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

Updates information about a registered game server to help Amazon GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group.

Use this operation to update the following types of game server information. You can make all three types of updates in the same request:

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

Amazon GameLift FleetIQ Guide

", + "UpdateGameServerGroup": "

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

Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.

To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide

", "UpdateGameSession": "

Updates the mutable properties of a game session.

To update a game session, specify the game session ID and the values you want to change.

If successful, the updated GameSession object is returned.

All APIs by task

", "UpdateGameSessionQueue": "

Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Learn more

Using Multi-Region Queues

", "UpdateMatchmakingConfiguration": "

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.

Learn more

Design a FlexMatch matchmaker

", - "UpdateRuntimeConfiguration": "

Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status.

To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations.

If successful, the fleet's runtime configuration settings are updated. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.

Learn more

Setting up GameLift fleets

", + "UpdateRuntimeConfiguration": "

Updates the current runtime configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status.

To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations.

If successful, the fleet's runtime configuration settings are updated. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.

Learn more

Setting up Amazon GameLift fleets

", "UpdateScript": "

Updates Realtime script metadata and content.

To update script metadata, specify the script ID and provide updated name and/or version values.

To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.

If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

", "ValidateMatchmakingRuleSet": "

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.

Learn more

" }, @@ -136,7 +136,7 @@ "AliasArn": { "base": null, "refs": { - "Alias$AliasArn": "

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

" + "Alias$AliasArn": "

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

" } }, "AliasId": { @@ -167,17 +167,17 @@ "AmazonResourceName": { "base": null, "refs": { - "ListTagsForResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

", - "TagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

", - "UntagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

" + "ListTagsForResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) that uniquely identifies the Amazon GameLift resource that you want to retrieve tags for. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a List or Describe operation for the resource type.

", + "TagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) that uniquely identifies the Amazon GameLift resource that you want to assign tags to. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a List or Describe operation for the resource type.

", + "UntagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) that uniquely identifies the Amazon GameLift resource that you want to remove tags from. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a List or Describe operation for the resource type.

" } }, "AnywhereConfiguration": { - "base": "

GameLift Anywhere configuration options for your Anywhere fleets.

", + "base": "

Amazon GameLift Anywhere configuration options for your Anywhere fleets.

", "refs": { - "CreateFleetInput$AnywhereConfiguration": "

GameLift Anywhere configuration options.

", + "CreateFleetInput$AnywhereConfiguration": "

Amazon GameLift Anywhere configuration options.

", "FleetAttributes$AnywhereConfiguration": null, - "UpdateFleetAttributesInput$AnywhereConfiguration": "

GameLift Anywhere configuration options.

" + "UpdateFleetAttributesInput$AnywhereConfiguration": "

Amazon GameLift Anywhere configuration options.

" } }, "ArnStringModel": { @@ -219,7 +219,7 @@ "BackfillMode": { "base": null, "refs": { - "CreateMatchmakingConfigurationInput$BackfillMode": "

The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

", + "CreateMatchmakingConfigurationInput$BackfillMode": "

The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

", "MatchmakingConfiguration$BackfillMode": "

The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

", "UpdateMatchmakingConfigurationInput$BackfillMode": "

The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

" } @@ -227,9 +227,9 @@ "BalancingStrategy": { "base": null, "refs": { - "CreateGameServerGroupInput$BalancingStrategy": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

", - "GameServerGroup$BalancingStrategy": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

", - "UpdateGameServerGroupInput$BalancingStrategy": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

" + "CreateGameServerGroupInput$BalancingStrategy": "

Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

", + "GameServerGroup$BalancingStrategy": "

Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

", + "UpdateGameServerGroupInput$BalancingStrategy": "

Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

" } }, "BooleanModel": { @@ -253,8 +253,8 @@ "BuildArn": { "base": null, "refs": { - "Build$BuildArn": "

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

", - "FleetAttributes$BuildArn": "

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

" + "Build$BuildArn": "

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

", + "FleetAttributes$BuildArn": "

The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

" } }, "BuildId": { @@ -267,7 +267,7 @@ "BuildIdOrArn": { "base": null, "refs": { - "CreateFleetInput$BuildId": "

The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to GameLift and in READY status. This fleet property cannot be changed later.

", + "CreateFleetInput$BuildId": "

The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY status. This fleet property cannot be changed later.

", "DeleteBuildInput$BuildId": "

A unique identifier for the build to delete. You can use either the build ID or ARN value.

", "DescribeBuildInput$BuildId": "

A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value.

", "ListFleetsInput$BuildId": "

A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

", @@ -289,9 +289,9 @@ } }, "CertificateConfiguration": { - "base": "

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

", + "base": "

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

", "refs": { - "CreateFleetInput$CertificateConfiguration": "

Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the CertificateConfiguration is DISABLED. You can't change this property after you create the fleet.

Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.

", + "CreateFleetInput$CertificateConfiguration": "

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED. You can't change this property after you create the fleet.

Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.

", "FleetAttributes$CertificateConfiguration": null } }, @@ -319,7 +319,7 @@ } }, "Compute": { - "base": "

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

", + "base": "

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

", "refs": { "ComputeList$member": null, "DescribeComputeOutput$Compute": "

The details of the compute resource you registered to the specified fleet.

", @@ -330,14 +330,14 @@ "base": null, "refs": { "Compute$ComputeArn": "

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

", - "GetComputeAccessOutput$ComputeArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "GetComputeAuthTokenOutput$ComputeArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912

" + "GetComputeAccessOutput$ComputeArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "GetComputeAuthTokenOutput$ComputeArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912

" } }, "ComputeAuthToken": { "base": null, "refs": { - "GetComputeAuthTokenOutput$AuthToken": "

The authorization token that your game server uses to authenticate with GameLift.

" + "GetComputeAuthTokenOutput$AuthToken": "

The authentication token that your game server uses to authenticate with Amazon GameLift.

" } }, "ComputeList": { @@ -360,8 +360,8 @@ "DescribeComputeInput$ComputeName": "

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

", "GetComputeAccessInput$ComputeName": "

The name of the compute resource you are requesting credentials for.

", "GetComputeAccessOutput$ComputeName": "

The name of the compute resource you requested credentials for.

", - "GetComputeAuthTokenInput$ComputeName": "

The name of the compute resource you are requesting the authorization token for.

", - "GetComputeAuthTokenOutput$ComputeName": "

The name of the compute resource you are requesting the authorization token for.

" + "GetComputeAuthTokenInput$ComputeName": "

The name of the compute resource you are requesting the authentication token for.

", + "GetComputeAuthTokenOutput$ComputeName": "

The name of the compute resource you are requesting the authentication token for.

" } }, "ComputeStatus": { @@ -373,8 +373,8 @@ "ComputeType": { "base": null, "refs": { - "CreateFleetInput$ComputeType": "

The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.

", - "FleetAttributes$ComputeType": "

The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.

" + "CreateFleetInput$ComputeType": "

The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift. By default, this property is set to EC2.

", + "FleetAttributes$ComputeType": "

The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

" } }, "ConflictException": { @@ -977,7 +977,7 @@ "DnsName": { "base": null, "refs": { - "Compute$DnsName": "

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

", + "Compute$DnsName": "

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

", "GameSession$DnsName": "

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

", "GameSessionConnectionInfo$DnsName": "

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

", "GameSessionPlacement$DnsName": "

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

", @@ -988,7 +988,7 @@ "DnsNameInput": { "base": null, "refs": { - "RegisterComputeInput$DnsName": "

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

" + "RegisterComputeInput$DnsName": "

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

" } }, "Double": { @@ -1013,7 +1013,7 @@ } }, "EC2InstanceLimit": { - "base": "

The GameLift service limits for an Amazon EC2 instance type and current utilization. GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with GameLift. You can request an limit increase for your account by using the Service limits page in the GameLift console.

", + "base": "

The Amazon GameLift service limits for an Amazon EC2 instance type and current utilization. Amazon GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with Amazon GameLift. You can request an limit increase for your account by using the Service limits page in the Amazon GameLift console.

", "refs": { "EC2InstanceLimitList$member": null } @@ -1027,9 +1027,9 @@ "EC2InstanceType": { "base": null, "refs": { - "Compute$Type": "

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

", - "CreateFleetInput$EC2InstanceType": "

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

", - "DescribeEC2InstanceLimitsInput$EC2InstanceType": "

Name of an Amazon EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.

", + "Compute$Type": "

The compute type that the fleet uses. A fleet can use Anywhere compute resources that you own, or use managed Amazon EC2 instances.

", + "CreateFleetInput$EC2InstanceType": "

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

", + "DescribeEC2InstanceLimitsInput$EC2InstanceType": "

Name of an Amazon EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.

", "EC2InstanceLimit$EC2InstanceType": "

The name of an Amazon EC2 instance type. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

", "FleetAttributes$InstanceType": "

The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

", "FleetCapacity$InstanceType": "

The Amazon EC2 instance type that is used for all instances in a fleet. The instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

", @@ -1037,7 +1037,7 @@ } }, "Event": { - "base": "

Log entry describing an event that involves GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

", + "base": "

Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

", "refs": { "EventList$member": null } @@ -1045,7 +1045,7 @@ "EventCode": { "base": null, "refs": { - "Event$EventCode": "

The type of event being logged.

Fleet state transition events:

Fleet creation events (ordered by fleet creation activity):

VPC peering events:

Spot instance events:

Server process events:

Game session events:

Other fleet events:

" + "Event$EventCode": "

The type of event being logged.

Fleet state transition events:

Fleet creation events (ordered by fleet creation activity):

VPC peering events:

Spot instance events:

Server process events:

Game session events:

Other fleet events:

" } }, "EventList": { @@ -1081,30 +1081,30 @@ "base": null, "refs": { "Compute$FleetArn": "

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

", - "CreateFleetLocationsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "DeleteFleetLocationsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "DescribeFleetLocationAttributesOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "DescribeFleetPortSettingsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "FleetAttributes$FleetArn": "

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

", - "FleetCapacity$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "FleetUtilization$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "CreateFleetLocationsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "DeleteFleetLocationsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "DescribeFleetLocationAttributesOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "DescribeFleetPortSettingsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "FleetAttributes$FleetArn": "

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

", + "FleetCapacity$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "FleetUtilization$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", "GameSession$FleetArn": "

The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

", - "GetComputeAccessOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "GetComputeAuthTokenOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "Instance$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "GetComputeAccessOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "GetComputeAuthTokenOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "Instance$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", "PlayerSession$FleetArn": "

The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

", "ResolveAliasOutput$FleetArn": "

The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to.

", - "ScalingPolicy$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "StartFleetActionsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "StopFleetActionsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "UpdateFleetAttributesOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "UpdateFleetCapacityOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", - "UpdateFleetPortSettingsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "ScalingPolicy$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "StartFleetActionsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "StopFleetActionsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "UpdateFleetAttributesOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "UpdateFleetCapacityOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", + "UpdateFleetPortSettingsOutput$FleetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

", "VpcPeeringConnection$FleetArn": "

The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.

" } }, "FleetAttributes": { - "base": "

Describes a GameLift fleet of game hosting resources.

Related actions

", + "base": "

Describes a Amazon GameLift fleet of game hosting resources.

Related actions

", "refs": { "CreateFleetOutput$FleetAttributes": "

The properties for the new fleet, including the current status. All fleets are placed in NEW status on creation.

", "FleetAttributesList$member": null @@ -1219,7 +1219,7 @@ "FleetStatus": { "base": null, "refs": { - "FleetAttributes$Status": "

Current status of the fleet. Possible fleet statuses include the following:

", + "FleetAttributes$Status": "

Current status of the fleet. Possible fleet statuses include the following:

", "LocationState$Status": "

The life-cycle status of a fleet location.

" } }, @@ -1246,9 +1246,9 @@ "FlexMatchMode": { "base": null, "refs": { - "CreateMatchmakingConfigurationInput$FlexMatchMode": "

Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

", - "MatchmakingConfiguration$FlexMatchMode": "

Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

", - "UpdateMatchmakingConfigurationInput$FlexMatchMode": "

Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

" + "CreateMatchmakingConfigurationInput$FlexMatchMode": "

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

", + "MatchmakingConfiguration$FlexMatchMode": "

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

", + "UpdateMatchmakingConfigurationInput$FlexMatchMode": "

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

" } }, "Float": { @@ -1261,19 +1261,19 @@ "base": null, "refs": { "Alias$Description": "

A human-readable description of an alias.

", - "Build$Name": "

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

", - "Build$Version": "

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

", + "Build$Name": "

A descriptive label associated with a build. Build names don't need to be unique. It can be set using CreateBuild or UpdateBuild.

", + "Build$Version": "

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

", "RoutingStrategy$Message": "

The message text to be used with a terminal routing strategy.

" } }, "GameLiftServiceSdkEndpointOutput": { "base": null, "refs": { - "Compute$GameLiftServiceSdkEndpoint": "

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

" + "Compute$GameLiftServiceSdkEndpoint": "

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

" } }, "GameProperty": { - "base": "

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the GameLift Developer Guide.

", + "base": "

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the Amazon GameLift Developer Guide.

", "refs": { "GamePropertyList$member": null } @@ -1303,7 +1303,7 @@ } }, "GameServer": { - "base": "

This data type is used with the GameLift FleetIQ and game server groups.

Properties describing a game server that is running on an instance in a game server group.

A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.

", + "base": "

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties describing a game server that is running on an instance in a game server group.

A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.

", "refs": { "ClaimGameServerOutput$GameServer": "

Object that describes the newly claimed game server.

", "DescribeGameServerOutput$GameServer": "

Object that describes the requested game server.

", @@ -1335,9 +1335,9 @@ } }, "GameServerGroup": { - "base": "

This data type is used with the GameLift FleetIQ and game server groups.

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon EC2 Auto Scaling group.

A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.

", + "base": "

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon EC2 Auto Scaling group.

A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.

", "refs": { - "CreateGameServerGroupOutput$GameServerGroup": "

The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The Amazon EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches ACTIVE.

", + "CreateGameServerGroupOutput$GameServerGroup": "

The newly created game server group object, including the new ARN value for the Amazon GameLift FleetIQ game server group and the object's status. The Amazon EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches ACTIVE.

", "DeleteGameServerGroupOutput$GameServerGroup": "

An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED.

", "DescribeGameServerGroupOutput$GameServerGroup": "

An object with the property settings for the requested game server group resource.

", "GameServerGroups$member": null, @@ -1369,7 +1369,7 @@ } }, "GameServerGroupAutoScalingPolicy": { - "base": "

This data type is used with the GameLift FleetIQ and game server groups.

Configuration settings for intelligent automatic scaling that uses target tracking. These settings are used to add an Auto Scaling policy when creating the corresponding Auto Scaling group. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.

", + "base": "

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Configuration settings for intelligent automatic scaling that uses target tracking. These settings are used to add an Auto Scaling policy when creating the corresponding Auto Scaling group. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.

", "refs": { "CreateGameServerGroupInput$AutoScalingPolicy": "

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric \"PercentUtilizedGameServers\" to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

" } @@ -1389,7 +1389,7 @@ "GameServerGroupName": { "base": null, "refs": { - "CreateGameServerGroupInput$GameServerGroupName": "

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.

", + "CreateGameServerGroupInput$GameServerGroupName": "

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the Amazon GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.

", "GameServer$GameServerGroupName": "

A unique identifier for the game server group where the game server is running.

", "GameServerGroup$GameServerGroupName": "

A developer-defined identifier for the game server group. The name is unique for each Region in each Amazon Web Services account.

", "GameServerInstance$GameServerGroupName": "

A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

" @@ -1398,7 +1398,7 @@ "GameServerGroupNameOrArn": { "base": null, "refs": { - "ClaimGameServerInput$GameServerGroupName": "

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

", + "ClaimGameServerInput$GameServerGroupName": "

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

", "DeleteGameServerGroupInput$GameServerGroupName": "

A unique identifier for the game server group. Use either the name or ARN value.

", "DeregisterGameServerInput$GameServerGroupName": "

A unique identifier for the game server group where the game server is running.

", "DescribeGameServerGroupInput$GameServerGroupName": "

A unique identifier for the game server group. Use either the name or ARN value.

", @@ -1415,7 +1415,7 @@ "GameServerGroupStatus": { "base": null, "refs": { - "GameServerGroup$Status": "

The current status of the game server group. Possible statuses include:

" + "GameServerGroup$Status": "

The current status of the game server group. Possible statuses include:

" } }, "GameServerGroups": { @@ -1433,7 +1433,7 @@ "GameServerId": { "base": null, "refs": { - "ClaimGameServerInput$GameServerId": "

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

", + "ClaimGameServerInput$GameServerId": "

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

", "DeregisterGameServerInput$GameServerId": "

A custom string that uniquely identifies the game server to deregister.

", "DescribeGameServerInput$GameServerId": "

A custom string that uniquely identifies the game server information to be retrieved.

", "GameServer$GameServerId": "

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an Amazon Web Services account.

", @@ -1442,7 +1442,7 @@ } }, "GameServerInstance": { - "base": "

This data type is used with the GameLift FleetIQ and game server groups.

Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.

Retrieve game server instances for a game server group by calling DescribeGameServerInstances.

", + "base": "

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.

Retrieve game server instances for a game server group by calling DescribeGameServerInstances.

", "refs": { "GameServerInstances$member": null } @@ -1559,7 +1559,7 @@ "GameSessionPlacementState": { "base": null, "refs": { - "GameSessionPlacement$Status": "

Current status of the game session placement request.

" + "GameSessionPlacement$Status": "

Current status of the game session placement request.

" } }, "GameSessionQueue": { @@ -1573,7 +1573,7 @@ "GameSessionQueueArn": { "base": null, "refs": { - "GameSessionQueue$GameSessionQueueArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a GameLift game session queue ARN, the resource ID matches the Name value.

" + "GameSessionQueue$GameSessionQueueArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

" } }, "GameSessionQueueDestination": { @@ -1696,7 +1696,7 @@ } }, "Instance": { - "base": "

Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In GameLift, a fleet can contain zero or more instances.

Related actions

", + "base": "

Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In Amazon GameLift, a fleet can contain zero or more instances.

Related actions

", "refs": { "InstanceList$member": null } @@ -1714,7 +1714,7 @@ } }, "InstanceDefinition": { - "base": "

This data type is used with the GameLift FleetIQ and game server groups.

An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.

", + "base": "

This data type is used with the Amazon GameLift FleetIQ and game server groups.

An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. Amazon GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.

", "refs": { "InstanceDefinitions$member": null } @@ -1722,9 +1722,9 @@ "InstanceDefinitions": { "base": null, "refs": { - "CreateGameServerGroupInput$InstanceDefinitions": "

The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon Elastic Compute Cloud User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", - "GameServerGroup$InstanceDefinitions": "

The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

", - "UpdateGameServerGroupInput$InstanceDefinitions": "

An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "CreateGameServerGroupInput$InstanceDefinitions": "

The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by Amazon GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon Elastic Compute Cloud User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "GameServerGroup$InstanceDefinitions": "

The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

", + "UpdateGameServerGroupInput$InstanceDefinitions": "

An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by Amazon GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, "InstanceId": { @@ -1745,7 +1745,7 @@ "InstanceStatus": { "base": null, "refs": { - "Instance$Status": "

Current status of the instance. Possible statuses include the following:

" + "Instance$Status": "

Current status of the instance. Possible statuses include the following:

" } }, "Integer": { @@ -1778,18 +1778,18 @@ "IpAddress": { "base": null, "refs": { - "Compute$IpAddress": "

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

", - "GameSession$IpAddress": "

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

", - "GameSessionConnectionInfo$IpAddress": "

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

", - "GameSessionPlacement$IpAddress": "

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

", + "Compute$IpAddress": "

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

", + "GameSession$IpAddress": "

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

", + "GameSessionConnectionInfo$IpAddress": "

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

", + "GameSessionPlacement$IpAddress": "

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

", "Instance$IpAddress": "

IP address that is assigned to the instance.

", "InstanceAccess$IpAddress": "

IP address that is assigned to the instance.

", - "PlayerSession$IpAddress": "

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

", - "RegisterComputeInput$IpAddress": "

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

" + "PlayerSession$IpAddress": "

The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

", + "RegisterComputeInput$IpAddress": "

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

" } }, "IpPermission": { - "base": "

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.

", + "base": "

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.

", "refs": { "IpPermissionsList$member": null } @@ -1797,7 +1797,7 @@ "IpPermissionsList": { "base": null, "refs": { - "CreateFleetInput$EC2InboundPermissions": "

The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.

", + "CreateFleetInput$EC2InboundPermissions": "

The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

", "DescribeFleetPortSettingsOutput$InboundPermissions": "

The port settings for the requested fleet ID.

", "UpdateFleetPortSettingsInput$InboundPermissionAuthorizations": "

A collection of port settings to be added to the fleet resource.

", "UpdateFleetPortSettingsInput$InboundPermissionRevocations": "

A collection of port settings to be removed from the fleet resource.

" @@ -1853,9 +1853,9 @@ } }, "LaunchTemplateSpecification": { - "base": "

This data type is used with the GameLift FleetIQ and game server groups.

An Amazon Elastic Compute Cloud launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group.

", + "base": "

This data type is used with the Amazon GameLift FleetIQ and game server groups.

An Amazon Elastic Compute Cloud launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group.

", "refs": { - "CreateGameServerGroupInput$LaunchTemplate": "

The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

If you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to \"true\". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.

" + "CreateGameServerGroupInput$LaunchTemplate": "

The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

If you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to \"true\". If no network interface is specified in the launch template, Amazon GameLift FleetIQ uses your account's default VPC.

" } }, "LaunchTemplateVersion": { @@ -1968,7 +1968,7 @@ "LocationArnModel": { "base": null, "refs": { - "LocationModel$LocationArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift location resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" + "LocationModel$LocationArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift location resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

" } }, "LocationAttributes": { @@ -1984,7 +1984,7 @@ } }, "LocationConfiguration": { - "base": "

A remote location where a multi-location fleet can deploy EC2 instances for game hosting.

", + "base": "

A remote location where a multi-location fleet can deploy game servers for game hosting.

", "refs": { "LocationConfigurationList$member": null } @@ -1992,8 +1992,8 @@ "LocationConfigurationList": { "base": null, "refs": { - "CreateFleetInput$Locations": "

A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2. To create a fleet with instances in the home Region only, omit this parameter.

", - "CreateFleetLocationsInput$Locations": "

A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

" + "CreateFleetInput$Locations": "

A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2. To create 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 request.

", + "CreateFleetLocationsInput$Locations": "

A list of locations to deploy additional instances to and manage as part of the fleet. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

" } }, "LocationFilter": { @@ -2031,7 +2031,7 @@ } }, "LocationState": { - "base": "

A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.

", + "base": "

A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.

", "refs": { "LocationAttributes$LocationState": "

A fleet location and its current life-cycle state.

", "LocationStateList$member": null @@ -2040,8 +2040,8 @@ "LocationStateList": { "base": null, "refs": { - "CreateFleetLocationsOutput$LocationStates": "

The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to NEW. During location creation, GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.

", - "CreateFleetOutput$LocationStates": "

The fleet's locations and life-cycle status of each location. For new fleets, the status of all locations is set to NEW. During fleet creation, GameLift updates each location status as instances are deployed there and prepared for game hosting. This list includes an entry for the fleet's home Region. For fleets with no remote locations, only one entry, representing the home Region, is returned.

", + "CreateFleetLocationsOutput$LocationStates": "

The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to NEW. During location creation, Amazon GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.

", + "CreateFleetOutput$LocationStates": "

The fleet's locations and life-cycle status of each location. For new fleets, the status of all locations is set to NEW. During fleet creation, Amazon GameLift updates each location status as instances are deployed there and prepared for game hosting. This list includes an entry for the fleet's home Region. For fleets with no remote locations, only one entry, representing the home Region, is returned.

", "DeleteFleetLocationsOutput$LocationStates": "

The remote locations that are being deleted, with each location status set to DELETING.

" } }, @@ -2124,7 +2124,7 @@ "MatchmakingConfigurationArn": { "base": "Data type used for Matchmaking Configuration ARN.", "refs": { - "MatchmakingConfiguration$ConfigurationArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name>. In a GameLift configuration ARN, the resource ID matches the Name value.

", + "MatchmakingConfiguration$ConfigurationArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name>. In a Amazon GameLift configuration ARN, the resource ID matches the Name value.

", "MatchmakingTicket$ConfigurationArn": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.

" } }, @@ -2198,7 +2198,7 @@ "base": "Data type used for Matchmaking RuleSet ARN.", "refs": { "MatchmakingConfiguration$RuleSetArn": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

", - "MatchmakingRuleSet$RuleSetArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.

" + "MatchmakingRuleSet$RuleSetArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.

" } }, "MatchmakingRuleSetList": { @@ -2302,13 +2302,13 @@ "ListAliasesInput$Name": "

A descriptive label that is associated with an alias. Alias names do not need to be unique.

", "ListAliasesInput$NextToken": "

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.

", "ListAliasesOutput$NextToken": "

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.

", - "ListBuildsInput$NextToken": "

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.

", + "ListBuildsInput$NextToken": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, don't specify a value.

", "ListBuildsOutput$NextToken": "

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.

", - "ListScriptsInput$NextToken": "

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.

", + "ListScriptsInput$NextToken": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, don't specify a value.

", "ListScriptsOutput$NextToken": "

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.

", "NotFoundException$Message": null, "OutOfCapacityException$Message": null, - "S3Location$Bucket": "

An Amazon S3 bucket identifier. Thename of the S3 bucket.

GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).

", + "S3Location$Bucket": "

An Amazon S3 bucket identifier. Thename of the S3 bucket.

Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).

", "S3Location$Key": "

The name of the zip file that contains the build files or script files.

", "S3Location$RoleArn": "

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

", "S3Location$ObjectVersion": "

The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

", @@ -2327,32 +2327,32 @@ "NonNegativeLimitedLengthDouble": { "base": null, "refs": { - "AnywhereConfiguration$Cost": "

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

" + "AnywhereConfiguration$Cost": "

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

" } }, "NonZeroAndMaxString": { "base": null, "refs": { "CreateAliasInput$Description": "

A human-readable description of the alias.

", - "CreateBuildInput$Name": "

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

", - "CreateBuildInput$Version": "

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

", + "CreateBuildInput$Name": "

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

", + "CreateBuildInput$Version": "

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

", "CreateFleetInput$Name": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

", "CreateFleetInput$Description": "

A description for the fleet.

", - "CreateFleetInput$PeerVpcAwsAccountId": "

Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.

", - "CreateFleetInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

", + "CreateFleetInput$PeerVpcAwsAccountId": "

Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.

", + "CreateFleetInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", "CreateGameSessionInput$Name": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

", - "CreateGameSessionInput$CreatorId": "

A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.

", + "CreateGameSessionInput$CreatorId": "

A unique identifier for a player or entity creating the game session.

If you add a resource creation limit policy to a fleet, the CreateGameSession operation requires a CreatorId. Amazon GameLift limits the number of game session creation requests with the same CreatorId in a specified time period.

If you your fleet doesn't have a resource creation limit policy and you provide a CreatorId in your CreateGameSession requests, Amazon GameLift limits requests to one request per CreatorId per second.

To not limit CreateGameSession requests with the same CreatorId, don't provide a CreatorId in your CreateGameSession request.

", "CreateMatchmakingConfigurationInput$Description": "

A human-readable description of the matchmaking configuration.

", "CreatePlayerSessionInput$PlayerId": "

A unique identifier for a player. Player IDs are developer-defined.

", - "CreateScriptInput$Name": "

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

", - "CreateScriptInput$Version": "

Version information associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

", - "CreateVpcPeeringAuthorizationInput$GameLiftAwsAccountId": "

A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

", - "CreateVpcPeeringAuthorizationInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

", + "CreateScriptInput$Name": "

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

", + "CreateScriptInput$Version": "

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

", + "CreateVpcPeeringAuthorizationInput$GameLiftAwsAccountId": "

A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

", + "CreateVpcPeeringAuthorizationInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", "CreateVpcPeeringConnectionInput$PeerVpcAwsAccountId": "

A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.

", - "CreateVpcPeeringConnectionInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

", + "CreateVpcPeeringConnectionInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", "DeleteScalingPolicyInput$Name": "

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

", - "DeleteVpcPeeringAuthorizationInput$GameLiftAwsAccountId": "

A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

", - "DeleteVpcPeeringAuthorizationInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

", + "DeleteVpcPeeringAuthorizationInput$GameLiftAwsAccountId": "

A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

", + "DeleteVpcPeeringAuthorizationInput$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", "DeleteVpcPeeringConnectionInput$VpcPeeringConnectionId": "

A unique identifier for a VPC peering connection.

", "DescribeFleetAttributesInput$NextToken": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

", "DescribeFleetAttributesOutput$NextToken": "

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.

", @@ -2389,7 +2389,7 @@ "DesiredPlayerSession$PlayerId": "

A unique identifier for a player to associate with the player session.

", "Event$EventId": "

A unique identifier for a fleet event.

", "Event$ResourceId": "

A unique identifier for an event resource, such as a fleet ID.

", - "Event$PreSignedLogUrl": "

Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the GameLift console.

", + "Event$PreSignedLogUrl": "

Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.

", "FleetAttributes$Description": "

A human-readable description of the fleet.

", "FleetAttributes$Name": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

", "GameServerGroup$StatusReason": "

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

", @@ -2425,10 +2425,10 @@ "PlayerSession$GameSessionId": "

A unique identifier for the game session that the player session is connected to.

", "PutScalingPolicyInput$Name": "

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

", "PutScalingPolicyOutput$Name": "

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

", - "RegisterComputeInput$CertificatePath": "

The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.

", + "RegisterComputeInput$CertificatePath": "

The path to the TLS certificate on your compute resource. The path and certificate are not validated by Amazon GameLift.

", "ScalingPolicy$Name": "

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

", - "Script$Name": "

A descriptive label that is associated with a script. Script names do not need to be unique.

", - "Script$Version": "

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

", + "Script$Name": "

A descriptive label that is associated with a script. Script names don't need to be unique.

", + "Script$Version": "

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

", "SearchGameSessionsInput$FilterExpression": "

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: \"maximumSessions>=10 AND hasAvailablePlayerSessions=true\".

", "SearchGameSessionsInput$SortExpression": "

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

For example, this sort expression returns the oldest active sessions first: \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value for the sort operand are returned at the end of the list.

", "SearchGameSessionsInput$NextToken": "

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.

", @@ -2436,20 +2436,20 @@ "StartGameSessionPlacementInput$GameSessionName": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

", "StringList$member": null, "UpdateAliasInput$Description": "

A human-readable description of the alias.

", - "UpdateBuildInput$Name": "

A descriptive label associated with a build. Build names do not need to be unique.

", - "UpdateBuildInput$Version": "

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

", + "UpdateBuildInput$Name": "

A descriptive label associated with a build. Build names don't need to be unique.

", + "UpdateBuildInput$Version": "

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

", "UpdateFleetAttributesInput$Name": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

", "UpdateFleetAttributesInput$Description": "

A human-readable description of a fleet.

", "UpdateGameSessionInput$Name": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

", "UpdateMatchmakingConfigurationInput$Description": "

A description for the matchmaking configuration.

", - "UpdateScriptInput$Name": "

A descriptive label that is associated with a script. Script names do not need to be unique.

", - "UpdateScriptInput$Version": "

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

", - "VpcPeeringAuthorization$GameLiftAwsAccountId": "

A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

", + "UpdateScriptInput$Name": "

A descriptive label that is associated with a script. Script names don't need to be unique.

", + "UpdateScriptInput$Version": "

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

", + "VpcPeeringAuthorization$GameLiftAwsAccountId": "

A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

", "VpcPeeringAuthorization$PeerVpcAwsAccountId": "

The authorization's peer VPC Amazon Web Services account ID.

", - "VpcPeeringAuthorization$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

", + "VpcPeeringAuthorization$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", "VpcPeeringConnection$IpV4CidrBlock": "

CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

", "VpcPeeringConnection$VpcPeeringConnectionId": "

A unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection.

", - "VpcPeeringConnection$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

", + "VpcPeeringConnection$PeerVpcId": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", "VpcPeeringConnection$GameLiftVpcId": "

A unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your Amazon Web Services account.

", "VpcPeeringConnectionStatus$Code": "

Code indicating the status of a VPC peering connection.

", "VpcPeeringConnectionStatus$Message": "

Additional messaging associated with the connection status.

" @@ -2465,7 +2465,7 @@ "refs": { "Build$OperatingSystem": "

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

", "Compute$OperatingSystem": "

The type of operating system on your compute resource.

", - "CreateBuildInput$OperatingSystem": "

The operating system that you built the game server binaries to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

", + "CreateBuildInput$OperatingSystem": "

The operating system that you built the game server binaries to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system isn't specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value can't be changed later.

", "FleetAttributes$OperatingSystem": "

The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

", "Instance$OperatingSystem": "

Operating system that is running on this instance.

", "InstanceAccess$OperatingSystem": "

Operating system that is running on the instance.

" @@ -2523,10 +2523,10 @@ "PlayerData": { "base": null, "refs": { - "CreatePlayerSessionInput$PlayerData": "

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

", - "DesiredPlayerSession$PlayerData": "

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

", + "CreatePlayerSessionInput$PlayerData": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

", + "DesiredPlayerSession$PlayerData": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

", "PlayerDataMap$value": null, - "PlayerSession$PlayerData": "

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

" + "PlayerSession$PlayerData": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" } }, "PlayerDataMap": { @@ -2622,17 +2622,17 @@ "PortNumber": { "base": null, "refs": { - "GameSession$Port": "

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

", - "GameSessionPlacement$Port": "

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

", - "IpPermission$FromPort": "

A starting value for a range of allowed port numbers.

For fleets using Windows and Linux builds, only ports 1026-60000 are valid.

", - "IpPermission$ToPort": "

An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

For fleets using Windows and Linux builds, only ports 1026-60000 are valid.

", + "GameSession$Port": "

The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

", + "GameSessionPlacement$Port": "

The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

", + "IpPermission$FromPort": "

A starting value for a range of allowed port numbers.

For fleets using Linux builds, only ports 22 and 1026-60000 are valid.

For fleets using Windows builds, only ports 1026-60000 are valid.

", + "IpPermission$ToPort": "

An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.

For fleets using Linux builds, only ports 22 and 1026-60000 are valid.

For fleets using Windows builds, only ports 1026-60000 are valid.

", "PlayerSession$Port": "

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

" } }, "PositiveInteger": { "base": null, "refs": { - "CreateGameServerGroupInput$MaxSize": "

The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

", + "CreateGameServerGroupInput$MaxSize": "

The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

", "DescribeFleetAttributesInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

", "DescribeFleetCapacityInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

", "DescribeFleetEventsInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

", @@ -2646,8 +2646,8 @@ "DescribeMatchmakingConfigurationsInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10.

", "DescribePlayerSessionsInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

", "DescribeScalingPoliciesInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

", - "GameServerGroupAutoScalingPolicy$EstimatedInstanceWarmup": "

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

", - "GameSessionConnectionInfo$Port": "

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

", + "GameServerGroupAutoScalingPolicy$EstimatedInstanceWarmup": "

Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

", + "GameSessionConnectionInfo$Port": "

The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

", "LatencyMap$value": null, "ListAliasesInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

", "ListBuildsInput$Limit": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

", @@ -2712,9 +2712,9 @@ "QueueArnsList": { "base": null, "refs": { - "CreateMatchmakingConfigurationInput$GameSessionQueueArns": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

", - "MatchmakingConfiguration$GameSessionQueueArns": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when FlexMatchMode is set to STANDALONE.

", - "UpdateMatchmakingConfigurationInput$GameSessionQueueArns": "

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

" + "CreateMatchmakingConfigurationInput$GameSessionQueueArns": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

", + "MatchmakingConfiguration$GameSessionQueueArns": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when FlexMatchMode is set to STANDALONE.

", + "UpdateMatchmakingConfigurationInput$GameSessionQueueArns": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

" } }, "QueueCustomEventData": { @@ -2774,7 +2774,7 @@ } }, "ResourceCreationLimitPolicy": { - "base": "

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

", + "base": "

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

", "refs": { "CreateFleetInput$ResourceCreationLimitPolicy": "

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

", "FleetAttributes$ResourceCreationLimitPolicy": null, @@ -2821,11 +2821,11 @@ } }, "RuntimeConfiguration": { - "base": "

A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet.

", + "base": "

A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Amazon GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet.

", "refs": { "CreateFleetInput$RuntimeConfiguration": "

Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.

", "DescribeRuntimeConfigurationOutput$RuntimeConfiguration": "

Instructions that describe how server processes should be launched and maintained on each instance in the fleet.

", - "UpdateRuntimeConfigurationInput$RuntimeConfiguration": "

Instructions for alaunching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.

", + "UpdateRuntimeConfigurationInput$RuntimeConfiguration": "

Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.

", "UpdateRuntimeConfigurationOutput$RuntimeConfiguration": "

The runtime configuration currently in use by all instances in the fleet. If the update was successful, all property changes are shown.

" } }, @@ -2879,7 +2879,7 @@ "base": null, "refs": { "FleetAttributes$ScriptArn": "

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

", - "Script$ScriptArn": "

The Amazon Resource Name (ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.

" + "Script$ScriptArn": "

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.

" } }, "ScriptId": { @@ -2892,7 +2892,7 @@ "ScriptIdOrArn": { "base": null, "refs": { - "CreateFleetInput$ScriptId": "

The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.

", + "CreateFleetInput$ScriptId": "

The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later.

", "DeleteScriptInput$ScriptId": "

A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.

", "DescribeScriptInput$ScriptId": "

A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.

", "ListFleetsInput$ScriptId": "

A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

", @@ -2930,8 +2930,8 @@ "ServerSdkVersion": { "base": "Data type used for server SDK version.", "refs": { - "Build$ServerSdkVersion": "

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

", - "CreateBuildInput$ServerSdkVersion": "

A server SDK version you used when integrating your game server build with GameLift. For more information see Integrate games with custom game servers.

" + "Build$ServerSdkVersion": "

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

", + "CreateBuildInput$ServerSdkVersion": "

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

" } }, "SnsArnStringModel": { @@ -3022,8 +3022,8 @@ "base": null, "refs": { "AcceptMatchInput$PlayerIds": "

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

", - "CreateFleetInput$LogPaths": "

This parameter is no longer used. To specify where GameLift should store log files once a server process shuts down, use the GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the GameLift Developer Guide.

", - "FleetAttributes$LogPaths": "

This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

" + "CreateFleetInput$LogPaths": "

This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.

", + "FleetAttributes$LogPaths": "

This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

" } }, "StringModel": { @@ -3044,7 +3044,7 @@ } }, "Tag": { - "base": "

A label that can be assigned to a GameLift resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", + "base": "

A label that you can assign to a Amazon GameLift resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

", "refs": { "TagList$member": null } @@ -3052,14 +3052,14 @@ "TagKey": { "base": null, "refs": { - "Tag$Key": "

The key for a developer-defined key:value pair for tagging an Amazon Web Services resource.

", + "Tag$Key": "

The key for a developer-defined key value pair for tagging an Amazon Web Services resource.

", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { - "UntagResourceRequest$TagKeys": "

A list of one or more tag keys to remove from the specified GameLift resource. An Amazon Web Services resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove.

" + "UntagResourceRequest$TagKeys": "

A list of one or more tag keys to remove from the specified Amazon GameLift resource.

" } }, "TagList": { @@ -3074,8 +3074,8 @@ "CreateMatchmakingConfigurationInput$Tags": "

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

", "CreateMatchmakingRuleSetInput$Tags": "

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

", "CreateScriptInput$Tags": "

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

", - "ListTagsForResourceResponse$Tags": "

The collection of tags that have been assigned to the specified resource.

", - "TagResourceRequest$Tags": "

A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources for actual tagging limits.

" + "ListTagsForResourceResponse$Tags": "

The collection of tags assigned to the resource.

", + "TagResourceRequest$Tags": "

A list of one or more tags to assign to the specified Amazon GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources for tagging limits.

" } }, "TagResourceRequest": { @@ -3091,7 +3091,7 @@ "TagValue": { "base": null, "refs": { - "Tag$Value": "

The value for a developer-defined key:value pair for tagging an Amazon Web Services resource.

" + "Tag$Value": "

The value for a developer-defined key value pair for tagging an Amazon Web Services resource.

" } }, "TaggingFailedException": { @@ -3107,9 +3107,9 @@ } }, "TargetTrackingConfiguration": { - "base": "

This data type is used with the GameLift FleetIQ and game server groups.

Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy . These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

", + "base": "

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy . These settings are used to create a target-based policy that tracks the Amazon GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

", "refs": { - "GameServerGroupAutoScalingPolicy$TargetTrackingConfiguration": "

Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

" + "GameServerGroupAutoScalingPolicy$TargetTrackingConfiguration": "

Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the Amazon GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

" } }, "TerminalRoutingStrategyException": { @@ -3138,7 +3138,7 @@ "GameSession$TerminationTime": "

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

", "GameSessionPlacement$StartTime": "

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

", "GameSessionPlacement$EndTime": "

Time stamp indicating when this request was completed, canceled, or timed out.

", - "GetComputeAuthTokenOutput$ExpirationTimestamp": "

The amount of time until the authorization token is no longer valid. To continue using the compute resource for game server hosting, renew the authorization token by using this operation again.

", + "GetComputeAuthTokenOutput$ExpirationTimestamp": "

The amount of time until the authentication token is no longer valid. To continue using the compute resource for game server hosting, renew the authentication token by using this operation again.

", "Instance$CreationTime": "

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

", "MatchmakingConfiguration$CreationTime": "

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

", "MatchmakingRuleSet$CreationTime": "

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

", @@ -3341,19 +3341,19 @@ "VpcSubnets": { "base": null, "refs": { - "CreateGameServerGroupInput$VpcSubnets": "

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.

" + "CreateGameServerGroupInput$VpcSubnets": "

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.

" } }, "WeightedCapacity": { "base": null, "refs": { - "InstanceDefinition$WeightedCapacity": "

Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value is \"1\".

" + "InstanceDefinition$WeightedCapacity": "

Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value is \"1\".

" } }, "WholeNumber": { "base": null, "refs": { - "CreateGameServerGroupInput$MinSize": "

The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

", + "CreateGameServerGroupInput$MinSize": "

The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.

", "CreateGameSessionInput$MaximumPlayerSessionCount": "

The maximum number of players that can be connected simultaneously to the game session.

", "CreateGameSessionQueueInput$TimeoutInSeconds": "

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

", "CreateMatchmakingConfigurationInput$AdditionalPlayerCount": "

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to STANDALONE.

", @@ -3378,7 +3378,7 @@ "MatchmakingTicket$EstimatedWaitTime": "

Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

", "PlayerLatencyPolicy$MaximumIndividualPlayerLatencyMilliseconds": "

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

", "PlayerLatencyPolicy$PolicyDurationSeconds": "

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

", - "ResourceCreationLimitPolicy$NewGameSessionsPerCreator": "

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

", + "ResourceCreationLimitPolicy$NewGameSessionsPerCreator": "

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

", "ResourceCreationLimitPolicy$PolicyPeriodInMinutes": "

The time span used in evaluating the resource creation limit policy.

", "StartGameSessionPlacementInput$MaximumPlayerSessionCount": "

The maximum number of players that can be connected simultaneously to the game session.

", "UpdateFleetCapacityInput$DesiredInstances": "

The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.

", diff --git a/models/apis/gamelift/2015-10-01/endpoint-rule-set-1.json b/models/apis/gamelift/2015-10-01/endpoint-rule-set-1.json index e2f1b4442c..d845bf7ea2 100644 --- a/models/apis/gamelift/2015-10-01/endpoint-rule-set-1.json +++ b/models/apis/gamelift/2015-10-01/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,23 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -71,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -140,90 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsFIPS" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] }, { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://gamelift-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsFIPS" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -231,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://gamelift-fips.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://gamelift.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -240,74 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://gamelift.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://gamelift.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/gamelift/2015-10-01/endpoint-tests-1.json b/models/apis/gamelift/2015-10-01/endpoint-tests-1.json index 9bf00e4563..03e11208d0 100644 --- a/models/apis/gamelift/2015-10-01/endpoint-tests-1.json +++ b/models/apis/gamelift/2015-10-01/endpoint-tests-1.json @@ -1,250 +1,250 @@ { "testCases": [ { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.ap-south-1.api.aws" + "url": "https://gamelift.af-south-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "ap-south-1", - "UseFIPS": true + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.ap-south-1.amazonaws.com" + "url": "https://gamelift.ap-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "ap-south-1", - "UseFIPS": true + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.ap-south-1.api.aws" + "url": "https://gamelift.ap-northeast-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "ap-south-1", - "UseFIPS": false + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.ap-south-1.amazonaws.com" + "url": "https://gamelift.ap-northeast-2.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "ap-south-1", - "UseFIPS": false + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-south-1.api.aws" + "url": "https://gamelift.ap-northeast-3.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "eu-south-1", - "UseFIPS": true + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-south-1.amazonaws.com" + "url": "https://gamelift.ap-south-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "eu-south-1", - "UseFIPS": true + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-south-1.api.aws" + "url": "https://gamelift.ap-southeast-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "eu-south-1", - "UseFIPS": false + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-south-1.amazonaws.com" + "url": "https://gamelift.ap-southeast-2.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "eu-south-1", - "UseFIPS": false + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.ca-central-1.api.aws" + "url": "https://gamelift.ca-central-1.amazonaws.com" } }, "params": { - "UseDualStack": true, "Region": "ca-central-1", - "UseFIPS": true + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.ca-central-1.amazonaws.com" + "url": "https://gamelift.eu-central-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "ca-central-1", - "UseFIPS": true + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.ca-central-1.api.aws" + "url": "https://gamelift.eu-north-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "ca-central-1", - "UseFIPS": false + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.ca-central-1.amazonaws.com" + "url": "https://gamelift.eu-south-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "ca-central-1", - "UseFIPS": false + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-central-1.api.aws" + "url": "https://gamelift.eu-west-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "eu-central-1", - "UseFIPS": true + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-central-1.amazonaws.com" + "url": "https://gamelift.eu-west-2.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "eu-central-1", - "UseFIPS": true + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-central-1.api.aws" + "url": "https://gamelift.eu-west-3.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "eu-central-1", - "UseFIPS": false + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-central-1.amazonaws.com" + "url": "https://gamelift.me-south-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "eu-central-1", - "UseFIPS": false + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.us-west-1.api.aws" + "url": "https://gamelift.sa-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "us-west-1", - "UseFIPS": true + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.us-west-1.amazonaws.com" + "url": "https://gamelift.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-west-1", - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.us-west-1.api.aws" + "url": "https://gamelift.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "us-west-1", - "UseFIPS": false + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -255,983 +255,331 @@ } }, "params": { - "UseDualStack": false, "Region": "us-west-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.us-west-2.api.aws" + "url": "https://gamelift.us-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, "Region": "us-west-2", - "UseFIPS": true + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.us-west-2.amazonaws.com" + "url": "https://gamelift-fips.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "Region": "us-west-2", - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.us-west-2.api.aws" + "url": "https://gamelift-fips.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "us-west-2", - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://gamelift.us-west-2.amazonaws.com" + "url": "https://gamelift.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "Region": "us-west-2", - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.af-south-1.api.aws" + "url": "https://gamelift.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": true, - "Region": "af-south-1", - "UseFIPS": true + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.af-south-1.amazonaws.com" + "url": "https://gamelift.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, - "Region": "af-south-1", - "UseFIPS": true + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://gamelift.af-south-1.api.aws" + "url": "https://gamelift-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseDualStack": true, - "Region": "af-south-1", - "UseFIPS": false + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.af-south-1.amazonaws.com" + "url": "https://gamelift-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, - "Region": "af-south-1", - "UseFIPS": false + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-north-1.api.aws" + "url": "https://gamelift.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseDualStack": true, - "Region": "eu-north-1", - "UseFIPS": true + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-north-1.amazonaws.com" + "url": "https://gamelift-fips.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "Region": "eu-north-1", - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-north-1.api.aws" + "url": "https://gamelift-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "eu-north-1", - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-north-1.amazonaws.com" + "url": "https://gamelift.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "Region": "eu-north-1", - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-west-3.api.aws" + "url": "https://gamelift.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "Region": "eu-west-3", - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://gamelift-fips.eu-west-3.amazonaws.com" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": false, - "Region": "eu-west-3", - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-west-3.api.aws" + "url": "https://gamelift-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": true, - "Region": "eu-west-3", - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://gamelift.eu-west-3.amazonaws.com" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": false, - "Region": "eu-west-3", - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-west-2.api.aws" + "url": "https://gamelift.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": true, - "Region": "eu-west-2", - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://gamelift-fips.eu-west-2.amazonaws.com" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": false, - "Region": "eu-west-2", - "UseFIPS": true + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-west-2.api.aws" + "url": "https://gamelift-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, - "Region": "eu-west-2", - "UseFIPS": false + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://gamelift.eu-west-2.amazonaws.com" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": false, - "Region": "eu-west-2", - "UseFIPS": false + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-west-1.api.aws" + "url": "https://gamelift.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, - "Region": "eu-west-1", - "UseFIPS": true + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://gamelift-fips.eu-west-1.amazonaws.com" + "url": "https://example.com" } }, "params": { + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-west-1", - "UseFIPS": true + "Endpoint": "https://example.com" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://gamelift.eu-west-1.api.aws" + "url": "https://example.com" } }, "params": { - "UseDualStack": true, - "Region": "eu-west-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { - "endpoint": { - "url": "https://gamelift.eu-west-1.amazonaws.com" - } + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-west-1", - "UseFIPS": false + "Endpoint": "https://example.com" } }, { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-northeast-3.api.aws" - } + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-northeast-3", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-3", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-northeast-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-3", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-3", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.me-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "me-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "me-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.me-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "me-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "me-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "sa-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "sa-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "sa-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "sa-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-2", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-2", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-2", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-2", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-northwest-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift-fips.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-northwest-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gamelift.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-northwest-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://gamelift.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-northwest-1", - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true, "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "documentation": "Missing region", "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false, - "Endpoint": "https://example.com" + "error": "Invalid Configuration: Missing Region" } } ], diff --git a/models/apis/guardduty/2017-11-28/api-2.json b/models/apis/guardduty/2017-11-28/api-2.json index b084f390c7..ef8418d7dd 100644 --- a/models/apis/guardduty/2017-11-28/api-2.json +++ b/models/apis/guardduty/2017-11-28/api-2.json @@ -2542,7 +2542,8 @@ "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", - "EKS_RUNTIME_MONITORING" + "EKS_RUNTIME_MONITORING", + "LAMBDA_NETWORK_LOGS" ] }, "DetectorFeatureConfiguration":{ @@ -2601,7 +2602,8 @@ "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", - "EKS_RUNTIME_MONITORING" + "EKS_RUNTIME_MONITORING", + "LAMBDA_NETWORK_LOGS" ] }, "DetectorId":{ @@ -3219,7 +3221,8 @@ "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", - "EKS_RUNTIME_MONITORING" + "EKS_RUNTIME_MONITORING", + "LAMBDA_NETWORK_LOGS" ] }, "GeoLocation":{ @@ -4141,6 +4144,47 @@ } } }, + "LambdaDetails":{ + "type":"structure", + "members":{ + "FunctionArn":{ + "shape":"String", + "locationName":"functionArn" + }, + "FunctionName":{ + "shape":"String", + "locationName":"functionName" + }, + "Description":{ + "shape":"String", + "locationName":"description" + }, + "LastModifiedAt":{ + "shape":"Timestamp", + "locationName":"lastModifiedAt" + }, + "RevisionId":{ + "shape":"String", + "locationName":"revisionId" + }, + "FunctionVersion":{ + "shape":"String", + "locationName":"functionVersion" + }, + "Role":{ + "shape":"String", + "locationName":"role" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "locationName":"vpcConfig" + }, + "Tags":{ + "shape":"Tags", + "locationName":"tags" + } + } + }, "Lineage":{ "type":"list", "member":{"shape":"LineageObject"} @@ -4945,7 +4989,8 @@ "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", - "EKS_RUNTIME_MONITORING" + "EKS_RUNTIME_MONITORING", + "LAMBDA_NETWORK_LOGS" ] }, "OrgFeatureAdditionalConfiguration":{ @@ -5541,6 +5586,10 @@ "RdsDbUserDetails":{ "shape":"RdsDbUserDetails", "locationName":"rdsDbUserDetails" + }, + "LambdaDetails":{ + "shape":"LambdaDetails", + "locationName":"lambdaDetails" } } }, @@ -6135,6 +6184,10 @@ } }, "String":{"type":"string"}, + "SubnetIds":{ + "type":"list", + "member":{"shape":"String"} + }, "Tag":{ "type":"structure", "members":{ @@ -6911,6 +6964,23 @@ "Volumes":{ "type":"list", "member":{"shape":"Volume"} + }, + "VpcConfig":{ + "type":"structure", + "members":{ + "SubnetIds":{ + "shape":"SubnetIds", + "locationName":"subnetIds" + }, + "VpcId":{ + "shape":"String", + "locationName":"vpcId" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "locationName":"securityGroups" + } + } } } } diff --git a/models/apis/guardduty/2017-11-28/docs-2.json b/models/apis/guardduty/2017-11-28/docs-2.json index ecd6acb74f..decc171045 100644 --- a/models/apis/guardduty/2017-11-28/docs-2.json +++ b/models/apis/guardduty/2017-11-28/docs-2.json @@ -1576,6 +1576,12 @@ "KubernetesDetails$KubernetesWorkloadDetails": "

Details about the Kubernetes workload involved in a Kubernetes finding.

" } }, + "LambdaDetails": { + "base": "

Information about the Lambda function involved in the finding.

", + "refs": { + "Resource$LambdaDetails": "

Contains information about the Lambda function that was involved in a finding.

" + } + }, "Lineage": { "base": null, "refs": { @@ -2409,7 +2415,8 @@ "SecurityGroups": { "base": null, "refs": { - "NetworkInterface$SecurityGroups": "

The security groups associated with the EC2 instance.

" + "NetworkInterface$SecurityGroups": "

The security groups associated with the EC2 instance.

", + "VpcConfig$SecurityGroups": "

The identifier of the security group attached to the Lambda function.

" } }, "Service": { @@ -2598,6 +2605,12 @@ "KubernetesWorkloadDetails$Type": "

Kubernetes workload type (e.g. Pod, Deployment, etc.).

", "KubernetesWorkloadDetails$Uid": "

Kubernetes workload ID.

", "KubernetesWorkloadDetails$Namespace": "

Kubernetes namespace that the workload is part of.

", + "LambdaDetails$FunctionArn": "

Amazon Resource Name (ARN) of the Lambda function.

", + "LambdaDetails$FunctionName": "

Name of the Lambda function.

", + "LambdaDetails$Description": "

Description of the Lambda function.

", + "LambdaDetails$RevisionId": "

The revision ID of the Lambda function version.

", + "LambdaDetails$FunctionVersion": "

The version of the Lambda function.

", + "LambdaDetails$Role": "

The execution role of the Lambda function.

", "LineageObject$Name": "

The name of the process.

", "LineageObject$Uuid": "

The unique ID assigned to the process by GuardDuty.

", "LineageObject$ExecutablePath": "

The absolute path of the process executable file.

", @@ -2716,6 +2729,7 @@ "SortCriteria$AttributeName": "

Represents the finding attribute, such as accountId, that sorts the findings.

", "SourceIps$member": null, "Sources$member": null, + "SubnetIds$member": null, "Tag$Key": "

The EC2 instance tag key.

", "Tag$Value": "

The EC2 instance tag value.

", "ThreatIntelSetIds$member": null, @@ -2738,7 +2752,14 @@ "VolumeDetail$SnapshotArn": "

Snapshot Arn of the EBS volume.

", "VolumeDetail$KmsKeyArn": "

KMS key Arn used to encrypt the EBS volume.

", "VolumeMount$Name": "

Volume mount name.

", - "VolumeMount$MountPath": "

Volume mount path.

" + "VolumeMount$MountPath": "

Volume mount path.

", + "VpcConfig$VpcId": "

The identifier of the Amazon Virtual Private Cloud.

" + } + }, + "SubnetIds": { + "base": null, + "refs": { + "VpcConfig$SubnetIds": "

The identifiers of the subnets that are associated with your Lambda function.

" } }, "Tag": { @@ -2800,6 +2821,7 @@ "EcsTaskDetails$Tags": "

The tags of the ECS Task.

", "EksClusterDetails$Tags": "

The EKS cluster tags.

", "InstanceDetails$Tags": "

The tags of the EC2 instance.

", + "LambdaDetails$Tags": "

A list of tags attached to this resource, listed in the format of key:value pair.

", "RdsDbInstanceDetails$Tags": "

Instance tag key-value pairs associated with the database instance ID.

", "S3BucketDetail$Tags": "

All tags attached to the S3 bucket

" } @@ -2864,6 +2886,7 @@ "EcsTaskDetails$TaskCreatedAt": "

The Unix timestamp for the time when the task was created.

", "EcsTaskDetails$StartedAt": "

The Unix timestamp for the time when the task started.

", "EksClusterDetails$CreatedAt": "

The timestamp when the EKS cluster was created.

", + "LambdaDetails$LastModifiedAt": "

The timestamp when the Lambda function was last modified. This field is in the UTC date string format (2023-03-22T19:37:20.168Z).

", "LineageObject$StartTime": "

The time when the process started. This is in UTC format.

", "MemberAdditionalConfigurationResult$UpdatedAt": "

The timestamp at which the additional configuration was set for the member account. This is in UTC format.

", "MemberFeaturesConfigurationResult$UpdatedAt": "

The timestamp at which the feature object was updated.

", @@ -3146,6 +3169,12 @@ "EcsTaskDetails$Volumes": "

The list of data volume definitions for the task.

", "KubernetesWorkloadDetails$Volumes": "

Volumes used by the Kubernetes workload.

" } + }, + "VpcConfig": { + "base": "

Amazon Virtual Private Cloud configuration details associated with your Lambda function.

", + "refs": { + "LambdaDetails$VpcConfig": "

Amazon Virtual Private Cloud configuration details associated with your Lambda function.

" + } } } } diff --git a/models/apis/guardduty/2017-11-28/endpoint-tests-1.json b/models/apis/guardduty/2017-11-28/endpoint-tests-1.json index ac82b920c9..a2e3b61e9a 100644 --- a/models/apis/guardduty/2017-11-28/endpoint-tests-1.json +++ b/models/apis/guardduty/2017-11-28/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "af-south-1", "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": false } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-east-1", "UseFIPS": false, - "Region": "ap-east-1" + "UseDualStack": false } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false, - "Region": "ap-northeast-1" + "UseDualStack": false } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-2", "UseFIPS": false, - "Region": "ap-northeast-2" + "UseDualStack": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-3", "UseFIPS": false, - "Region": "ap-northeast-3" + "UseDualStack": false } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": false } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-1", "UseFIPS": false, - "Region": "ap-southeast-1" + "UseDualStack": false } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "ap-southeast-2" + "UseDualStack": false } }, { @@ -112,9 +112,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-3", "UseFIPS": false, - "Region": "ap-southeast-3" + "UseDualStack": false } }, { @@ -125,9 +125,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -138,9 +138,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { @@ -151,9 +151,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false } }, { @@ -164,9 +164,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-south-1", "UseFIPS": false, - "Region": "eu-south-1" + "UseDualStack": false } }, { @@ -177,9 +177,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false } }, { @@ -190,9 +190,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { @@ -203,9 +203,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-3", "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false } }, { @@ -216,9 +216,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "me-south-1", "UseFIPS": false, - "Region": "me-south-1" + "UseDualStack": false } }, { @@ -229,9 +229,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": false } }, { @@ -242,9 +242,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -255,9 +255,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -268,9 +268,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -281,9 +281,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": true, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -294,9 +294,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -307,9 +307,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": true, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -320,9 +320,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -333,9 +333,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": true, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -346,9 +346,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -359,9 +359,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -372,9 +372,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -385,9 +385,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-northwest-1", "UseFIPS": false, - "Region": "cn-northwest-1" + "UseDualStack": false } }, { @@ -398,9 +398,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -411,9 +411,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -424,9 +424,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -437,9 +437,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -450,9 +450,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -463,9 +463,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": false, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { @@ -476,9 +476,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": true, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { @@ -489,9 +489,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -502,9 +502,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -513,9 +513,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -526,9 +526,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -537,9 +537,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -550,9 +550,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -561,9 +561,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -574,9 +574,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -585,9 +585,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -598,9 +598,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -611,9 +611,9 @@ } }, "params": { - "UseDualStack": false, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -625,8 +625,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -636,9 +636,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -648,9 +648,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } }, diff --git a/models/apis/iot/2015-05-28/api-2.json b/models/apis/iot/2015-05-28/api-2.json index 6ee536cfcf..97e12c4e79 100644 --- a/models/apis/iot/2015-05-28/api-2.json +++ b/models/apis/iot/2015-05-28/api-2.json @@ -7,7 +7,7 @@ "serviceFullName":"AWS IoT", "serviceId":"IoT", "signatureVersion":"v4", - "signingName":"execute-api", + "signingName":"iot", "uid":"iot-2015-05-28" }, "operations":{ @@ -11041,7 +11041,6 @@ "OTAUpdateFiles":{ "type":"list", "member":{"shape":"OTAUpdateFile"}, - "max":50, "min":1 }, "OTAUpdateId":{ @@ -11077,7 +11076,9 @@ "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", - "CREATE_FAILED" + "CREATE_FAILED", + "DELETE_IN_PROGRESS", + "DELETE_FAILED" ] }, "OTAUpdateSummary":{ diff --git a/models/apis/iot/2015-05-28/paginators-1.json b/models/apis/iot/2015-05-28/paginators-1.json index 61293e3d27..f4bca55b6b 100644 --- a/models/apis/iot/2015-05-28/paginators-1.json +++ b/models/apis/iot/2015-05-28/paginators-1.json @@ -144,6 +144,12 @@ "output_token": "nextToken", "result_key": "jobs" }, + "ListManagedJobTemplates": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "managedJobTemplates" + }, "ListMetricValues": { "input_token": "nextToken", "limit_key": "maxResults", @@ -204,6 +210,12 @@ "output_token": "nextToken", "result_key": "templates" }, + "ListRelatedResourcesForAuditFinding": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "relatedResources" + }, "ListRoleAliases": { "input_token": "marker", "limit_key": "pageSize", diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index 3486f56ff9..f7ab86d8bb 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -4714,7 +4714,8 @@ "CanvasAppSettings":{ "type":"structure", "members":{ - "TimeSeriesForecastingSettings":{"shape":"TimeSeriesForecastingSettings"} + "TimeSeriesForecastingSettings":{"shape":"TimeSeriesForecastingSettings"}, + "ModelRegisterSettings":{"shape":"ModelRegisterSettings"} } }, "CapacitySize":{ @@ -15101,6 +15102,13 @@ "GroundTruthS3Input":{"shape":"MonitoringGroundTruthS3Input"} } }, + "ModelRegisterSettings":{ + "type":"structure", + "members":{ + "Status":{"shape":"FeatureStatus"}, + "CrossAccountModelRegisterRoleArn":{"shape":"RoleArn"} + } + }, "ModelSortKey":{ "type":"string", "enum":[ diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index c53e2dba07..cb208948c5 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -3,8 +3,8 @@ "service": "

Provides APIs for creating and managing SageMaker resources.

Other Resources:

", "operations": { "AddAssociation": "

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "AddTags": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

", - "AssociateTrialComponent": "

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", + "AddTags": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

", + "AssociateTrialComponent": "

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", "BatchDescribeModelPackage": "

This action batch describes a list of versioned model packages

", "CreateAction": "

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

", "CreateAlgorithm": "

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

", @@ -14,7 +14,7 @@ "CreateAutoMLJob": "

Creates an Autopilot job.

Find the best-performing model after you run an Autopilot job by calling DescribeAutoMLJob.

For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.

", "CreateAutoMLJobV2": "

Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for Computer Vision or Natural Language Processing problems.

Find the resulting model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

To create an AutoMLJob using tabular data, see CreateAutoMLJob.

This API action is callable through SageMaker Canvas only. Calling it directly from the CLI or an SDK results in an error.

", "CreateCodeRepository": "

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

", - "CreateCompilationJob": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", + "CreateCompilationJob": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", "CreateContext": "

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

", "CreateDataQualityJobDefinition": "

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

", "CreateDeviceFleet": "

Creates a device fleet.

", @@ -22,9 +22,9 @@ "CreateEdgeDeploymentPlan": "

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

", "CreateEdgeDeploymentStage": "

Creates a new stage in an existing edge deployment plan.

", "CreateEdgePackagingJob": "

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

", - "CreateEndpoint": "

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

", - "CreateEndpointConfig": "

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

", - "CreateExperiment": "

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

", + "CreateEndpoint": "

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

", + "CreateEndpointConfig": "

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

", + "CreateExperiment": "

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

", "CreateFeatureGroup": "

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

", "CreateFlowDefinition": "

Creates a flow definition.

", "CreateHub": "

Create a hub.

Hub APIs are only callable through SageMaker Studio.

", @@ -48,17 +48,17 @@ "CreateNotebookInstanceLifecycleConfig": "

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

", "CreatePipeline": "

Creates a pipeline using a JSON pipeline definition.

", "CreatePresignedDomainUrl": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

", - "CreatePresignedNotebookInstanceUrl": "

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

", + "CreatePresignedNotebookInstanceUrl": "

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

", "CreateProcessingJob": "

Creates a processing job.

", "CreateProject": "

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

", "CreateSpace": "

Creates a space used for real time collaboration in a Domain.

", "CreateStudioLifecycleConfig": "

Creates a new Studio Lifecycle Configuration.

", "CreateTrainingJob": "

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

For more information about SageMaker, see How It Works.

", "CreateTransformJob": "

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

For more information about how batch transformation works, see Batch Transform.

", - "CreateTrial": "

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

", - "CreateTrialComponent": "

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

", + "CreateTrial": "

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

", + "CreateTrialComponent": "

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

", "CreateUserProfile": "

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

", - "CreateWorkforce": "

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

", + "CreateWorkforce": "

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

", "CreateWorkteam": "

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

", "DeleteAction": "

Deletes an action.

", "DeleteAlgorithm": "

Removes the specified algorithm from your account.

", @@ -75,12 +75,12 @@ "DeleteEdgeDeploymentStage": "

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

", "DeleteEndpoint": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

", "DeleteEndpointConfig": "

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", - "DeleteExperiment": "

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

", + "DeleteExperiment": "

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

", "DeleteFeatureGroup": "

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

", "DeleteFlowDefinition": "

Deletes the specified flow definition.

", "DeleteHub": "

Delete a hub.

Hub APIs are only callable through SageMaker Studio.

", "DeleteHubContent": "

Delete the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

", - "DeleteHumanTaskUi": "

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

", + "DeleteHumanTaskUi": "

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

", "DeleteImage": "

Deletes a SageMaker image and all versions of the image. The container images aren't deleted.

", "DeleteImageVersion": "

Deletes a version of a SageMaker image. The container image the version represents isn't deleted.

", "DeleteInferenceExperiment": "

Deletes an inference experiment.

This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

", @@ -100,10 +100,10 @@ "DeleteSpace": "

Used to delete a space.

", "DeleteStudioLifecycleConfig": "

Deletes the Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

", "DeleteTags": "

Deletes the specified tags from an SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.

", - "DeleteTrial": "

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

", - "DeleteTrialComponent": "

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", + "DeleteTrial": "

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

", + "DeleteTrialComponent": "

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", "DeleteUserProfile": "

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

", - "DeleteWorkforce": "

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use to create a new workforce.

If a private workforce contains one or more work teams, you must use the operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

", + "DeleteWorkforce": "

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

", "DeleteWorkteam": "

Deletes an existing work team. This operation can't be undone.

", "DeregisterDevices": "

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

", "DescribeAction": "

Describes an action.

", @@ -114,7 +114,7 @@ "DescribeAutoMLJob": "

Returns information about an Amazon SageMaker AutoML job.

", "DescribeAutoMLJobV2": "

Returns information about an Amazon SageMaker AutoML V2 job.

This API action is callable through SageMaker Canvas only. Calling it directly from the CLI or an SDK results in an error.

", "DescribeCodeRepository": "

Gets details about the specified Git repository.

", - "DescribeCompilationJob": "

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", + "DescribeCompilationJob": "

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", "DescribeContext": "

Describes a context.

", "DescribeDataQualityJobDefinition": "

Gets the details of a data quality monitoring job definition.

", "DescribeDevice": "

Describes the device.

", @@ -165,7 +165,7 @@ "DescribeWorkforce": "

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

", "DescribeWorkteam": "

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

", "DisableSagemakerServicecatalogPortfolio": "

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

", - "DisassociateTrialComponent": "

Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

", + "DisassociateTrialComponent": "

Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

", "EnableSagemakerServicecatalogPortfolio": "

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

", "GetDeviceFleetReport": "

Describes a fleet.

", "GetLineageGroupPolicy": "

The resource policy for the lineage group.

", @@ -183,7 +183,7 @@ "ListAutoMLJobs": "

Request a list of jobs.

", "ListCandidatesForAutoMLJob": "

List the candidates created for the job.

", "ListCodeRepositories": "

Gets a list of the Git repositories in your account.

", - "ListCompilationJobs": "

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

", + "ListCompilationJobs": "

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

", "ListContexts": "

Lists the contexts in your account and their properties.

", "ListDataQualityJobDefinitions": "

Lists the data quality job definitions in your account.

", "ListDeviceFleets": "

Returns a list of devices in the fleet.

", @@ -200,7 +200,7 @@ "ListHubContents": "

List the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

", "ListHubs": "

List all existing hubs.

Hub APIs are only callable through SageMaker Studio.

", "ListHumanTaskUis": "

Returns information about the human task user interfaces in your account.

", - "ListHyperParameterTuningJobs": "

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

", + "ListHyperParameterTuningJobs": "

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

", "ListImageVersions": "

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

", "ListImages": "

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

", "ListInferenceExperiments": "

Returns the list of all inference experiments.

", @@ -223,7 +223,7 @@ "ListMonitoringAlerts": "

Gets the alerts for a single monitoring schedule.

", "ListMonitoringExecutions": "

Returns list of all monitoring job executions.

", "ListMonitoringSchedules": "

Returns list of all monitoring schedules.

", - "ListNotebookInstanceLifecycleConfigs": "

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

", + "ListNotebookInstanceLifecycleConfigs": "

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

", "ListNotebookInstances": "

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

", "ListPipelineExecutionSteps": "

Gets a list of PipeLineExecutionStep objects.

", "ListPipelineExecutions": "

Gets a list of the pipeline executions.

", @@ -237,7 +237,7 @@ "ListSubscribedWorkteams": "

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

", "ListTags": "

Returns the tags for the specified SageMaker resource.

", "ListTrainingJobs": "

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

", - "ListTrainingJobsForHyperParameterTuningJob": "

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

", + "ListTrainingJobsForHyperParameterTuningJob": "

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

", "ListTransformJobs": "

Lists transform jobs.

", "ListTrialComponents": "

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

", "ListTrials": "

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

", @@ -258,7 +258,7 @@ "StartNotebookInstance": "

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

", "StartPipelineExecution": "

Starts a pipeline execution.

", "StopAutoMLJob": "

A method for forcing a running job to shut down.

", - "StopCompilationJob": "

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.

", + "StopCompilationJob": "

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

", "StopEdgeDeploymentStage": "

Stops a stage in an edge deployment plan.

", "StopEdgePackagingJob": "

Request to stop an edge packaging job.

", "StopHyperParameterTuningJob": "

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

", @@ -279,21 +279,21 @@ "UpdateDeviceFleet": "

Updates a fleet of devices.

", "UpdateDevices": "

Updates one or more devices in a fleet.

", "UpdateDomain": "

Updates the default settings for new user profiles in the domain.

", - "UpdateEndpoint": "

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", - "UpdateEndpointWeightsAndCapacities": "

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

", + "UpdateEndpoint": "

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", + "UpdateEndpointWeightsAndCapacities": "

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

", "UpdateExperiment": "

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

", "UpdateFeatureGroup": "

Updates the feature group.

", "UpdateFeatureMetadata": "

Updates the description and parameters of the feature group.

", "UpdateHub": "

Update a hub.

Hub APIs are only callable through SageMaker Studio.

", - "UpdateImage": "

Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.

", + "UpdateImage": "

Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.

", "UpdateImageVersion": "

Updates the properties of a SageMaker image version.

", - "UpdateInferenceExperiment": "

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperimentResponse$Status.

", + "UpdateInferenceExperiment": "

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

", "UpdateModelCard": "

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

", "UpdateModelPackage": "

Updates a versioned model.

", "UpdateMonitoringAlert": "

Update the parameters of a model monitor alert.

", "UpdateMonitoringSchedule": "

Updates a previously created schedule.

", "UpdateNotebookInstance": "

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

", - "UpdateNotebookInstanceLifecycleConfig": "

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

", + "UpdateNotebookInstanceLifecycleConfig": "

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

", "UpdatePipeline": "

Updates a pipeline.

", "UpdatePipelineExecution": "

Updates a pipeline execution.

", "UpdateProject": "

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

", @@ -302,7 +302,7 @@ "UpdateTrial": "

Updates the display name of a trial.

", "UpdateTrialComponent": "

Updates one or more properties of a trial component.

", "UpdateUserProfile": "

Updates a user profile.

", - "UpdateWorkforce": "

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the operation.

This operation only applies to private workforces.

", + "UpdateWorkforce": "

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

", "UpdateWorkteam": "

Updates an existing work team with new member definitions or description.

" }, "shapes": { @@ -455,7 +455,7 @@ } }, "AlgorithmSpecification": { - "base": "

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", + "base": "

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", "refs": { "CreateTrainingJobRequest$AlgorithmSpecification": "

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", "DescribeTrainingJobResponse$AlgorithmSpecification": "

Information about the algorithm used for training, and algorithm metadata.

", @@ -819,7 +819,7 @@ "AsyncNotificationTopicTypeList": { "base": null, "refs": { - "AsyncInferenceNotificationConfig$IncludeInferenceResponseIn": "

The Amazon SNS topics where you want the inference response to be included.

" + "AsyncInferenceNotificationConfig$IncludeInferenceResponseIn": "

The Amazon SNS topics where you want the inference response to be included.

The inference response is included only if the response size is less than or equal to 128 KB.

" } }, "AsyncNotificationTopicTypes": { @@ -1329,7 +1329,7 @@ "Boolean": { "base": null, "refs": { - "AlgorithmSpecification$EnableSageMakerMetricsTimeSeries": "

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

", + "AlgorithmSpecification$EnableSageMakerMetricsTimeSeries": "

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

", "AutoMLSecurityConfig$EnableInterContainerTrafficEncryption": "

Whether to use traffic encryption between the container layers.

", "BatchDataCaptureConfig$GenerateInferenceId": "

Flag that indicates whether to append inference id to the output.

", "ChannelSpecification$IsRequired": "

Indicates whether the channel is required by the algorithm.

", @@ -1357,7 +1357,7 @@ "MonitoringNetworkConfig$EnableNetworkIsolation": "

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

", "NetworkConfig$EnableInterContainerTrafficEncryption": "

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

", "NetworkConfig$EnableNetworkIsolation": "

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

", - "OfflineStoreConfig$DisableGlueTableCreation": "

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore.

", + "OfflineStoreConfig$DisableGlueTableCreation": "

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.

The default value is False.

", "OnlineStoreConfig$EnableOnlineStore": "

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

", "QualityCheckStepMetadata$SkipCheck": "

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", "QualityCheckStepMetadata$RegisterNewBaseline": "

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

", @@ -1471,7 +1471,7 @@ } }, "CanvasAppSettings": { - "base": "

The SageMaker Canvas app settings.

", + "base": "

The SageMaker Canvas application settings.

", "refs": { "UserSettings$CanvasAppSettings": "

The Canvas app settings.

" } @@ -1559,7 +1559,7 @@ "CategoricalParameterRanges": { "base": null, "refs": { - "ParameterRanges$CategoricalParameterRanges": "

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

" + "ParameterRanges$CategoricalParameterRanges": "

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

" } }, "CategoricalParameters": { @@ -1946,13 +1946,13 @@ "refs": { "CompilationJobSummary$CompilationJobStatus": "

The status of the model compilation job.

", "DescribeCompilationJobResponse$CompilationJobStatus": "

The status of the model compilation job.

", - "ListCompilationJobsRequest$StatusEquals": "

A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

" + "ListCompilationJobsRequest$StatusEquals": "

A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

" } }, "CompilationJobSummaries": { "base": null, "refs": { - "ListCompilationJobsResponse$CompilationJobSummaries": "

An array of CompilationJobSummary objects, each describing a model compilation job.

" + "ListCompilationJobsResponse$CompilationJobSummaries": "

An array of CompilationJobSummary objects, each describing a model compilation job.

" } }, "CompilationJobSummary": { @@ -1964,7 +1964,7 @@ "CompilerOptions": { "base": null, "refs": { - "OutputConfig$CompilerOptions": "

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

" + "OutputConfig$CompilerOptions": "

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

" } }, "CompleteOnConvergence": { @@ -2183,7 +2183,7 @@ "ContinuousParameterRanges": { "base": null, "refs": { - "ParameterRanges$ContinuousParameterRanges": "

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

" + "ParameterRanges$ContinuousParameterRanges": "

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

" } }, "ConvergenceDetected": { @@ -2859,7 +2859,7 @@ "DataInputConfig": { "base": null, "refs": { - "InputConfig$DataInputConfig": "

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):

CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

", + "InputConfig$DataInputConfig": "

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.

DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):

CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

", "ModelInput$DataInputConfig": "

The input configuration object for the model.

" } }, @@ -3283,7 +3283,7 @@ } }, "DeployedImage": { - "base": "

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

", + "base": "

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

", "refs": { "DeployedImages$member": null } @@ -4541,8 +4541,8 @@ "EndpointConfigName": { "base": null, "refs": { - "CreateEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

", - "CreateEndpointInput$EndpointConfigName": "

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

", + "CreateEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

", + "CreateEndpointInput$EndpointConfigName": "

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

", "DeleteEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration that you want to delete.

", "DescribeEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration.

", "DescribeEndpointConfigOutput$EndpointConfigName": "

Name of the SageMaker endpoint configuration.

", @@ -4616,7 +4616,7 @@ "EndpointName": { "base": null, "refs": { - "CreateEndpointInput$EndpointName": "

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in .

", + "CreateEndpointInput$EndpointName": "

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

", "CreateInferenceExperimentRequest$EndpointName": "

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

", "DeleteEndpointInput$EndpointName": "

The name of the endpoint that you want to delete.

", "DescribeEndpointInput$EndpointName": "

The name of the endpoint.

", @@ -4679,10 +4679,10 @@ "EndpointStatus": { "base": null, "refs": { - "DescribeEndpointOutput$EndpointStatus": "

The status of the endpoint.

", + "DescribeEndpointOutput$EndpointStatus": "

The status of the endpoint.

", "Endpoint$EndpointStatus": "

The status of the endpoint.

", - "EndpointMetadata$EndpointStatus": "

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary$EndpointStatus.

", - "EndpointSummary$EndpointStatus": "

The status of the endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

", + "EndpointMetadata$EndpointStatus": "

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.

", + "EndpointSummary$EndpointStatus": "

The status of the endpoint.

To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

", "ListEndpointsInput$StatusEquals": "

A filter that returns only endpoints with the specified status.

", "ModelDashboardEndpoint$EndpointStatus": "

The endpoint status.

" } @@ -4908,7 +4908,7 @@ } }, "Experiment": { - "base": "

The properties of an experiment as returned by the Search API.

", + "base": "

The properties of an experiment as returned by the Search API.

", "refs": { "SearchRecord$Experiment": "

The properties of an experiment.

" } @@ -4925,7 +4925,7 @@ } }, "ExperimentConfig": { - "base": "

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

", + "base": "

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

", "refs": { "CreateProcessingJobRequest$ExperimentConfig": null, "CreateTrainingJobRequest$ExperimentConfig": null, @@ -5065,7 +5065,7 @@ } }, "ExperimentSummary": { - "base": "

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

", + "base": "

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

", "refs": { "ExperimentSummaries$member": null } @@ -5331,7 +5331,8 @@ "FeatureStatus": { "base": null, "refs": { - "TimeSeriesForecastingSettings$Status": "

Describes whether time series forecasting is enabled or disabled in the Canvas app.

" + "ModelRegisterSettings$Status": "

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

", + "TimeSeriesForecastingSettings$Status": "

Describes whether time series forecasting is enabled or disabled in the Canvas application.

" } }, "FeatureType": { @@ -5380,7 +5381,7 @@ } }, "Filter": { - "base": "

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":

{

\"Name\": \"Metrics.accuracy\",

\"Operator\": \"GreaterThan\",

\"Value\": \"0.9\"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":

{

\"Name\": \"HyperParameters.learning_rate\",

\"Operator\": \"LessThan\",

\"Value\": \"0.5\"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

", + "base": "

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":

{

\"Name\": \"Metrics.accuracy\",

\"Operator\": \"GreaterThan\",

\"Value\": \"0.9\"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":

{

\"Name\": \"HyperParameters.learning_rate\",

\"Operator\": \"LessThan\",

\"Value\": \"0.5\"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

", "refs": { "FilterList$member": null } @@ -5405,9 +5406,9 @@ } }, "FinalHyperParameterTuningJobObjectiveMetric": { - "base": "

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

", + "base": "

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

", "refs": { - "HyperParameterTrainingJobSummary$FinalHyperParameterTuningJobObjectiveMetric": "

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

" + "HyperParameterTrainingJobSummary$FinalHyperParameterTuningJobObjectiveMetric": "

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

" } }, "FinalMetricDataList": { @@ -5847,7 +5848,7 @@ } }, "HumanLoopActivationConditionsConfig": { - "base": "

Defines under what conditions SageMaker creates a human loop. Used within . See for the required format of activation conditions.

", + "base": "

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.

", "refs": { "HumanLoopActivationConfig$HumanLoopActivationConditionsConfig": "

Container structure for defining under what conditions SageMaker creates a human loop.

" } @@ -5887,7 +5888,7 @@ "DescribeHumanTaskUiResponse$HumanTaskUiArn": "

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

", "HumanLoopConfig$HumanTaskUiArn": "

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

", "HumanTaskUiSummary$HumanTaskUiArn": "

The Amazon Resource Name (ARN) of the human task user interface.

", - "RenderUiTemplateRequest$HumanTaskUiArn": "

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

", + "RenderUiTemplateRequest$HumanTaskUiArn": "

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

", "UiConfig$HumanTaskUiArn": "

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

" } }, @@ -5922,7 +5923,7 @@ "HyperParameterAlgorithmSpecification": { "base": "

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

", "refs": { - "HyperParameterTrainingJobDefinition$AlgorithmSpecification": "

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

" + "HyperParameterTrainingJobDefinition$AlgorithmSpecification": "

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

" } }, "HyperParameterKey": { @@ -5953,8 +5954,8 @@ "HyperParameterTrainingJobDefinition": { "base": "

Defines the training jobs launched by a hyperparameter tuning job.

", "refs": { - "CreateHyperParameterTuningJobRequest$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

", - "DescribeHyperParameterTuningJobResponse$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

", + "CreateHyperParameterTuningJobRequest$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

", + "DescribeHyperParameterTuningJobResponse$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

", "HyperParameterTrainingJobDefinitions$member": null, "HyperParameterTuningJobSearchEntity$TrainingJobDefinition": null } @@ -5969,8 +5970,8 @@ "HyperParameterTrainingJobDefinitions": { "base": null, "refs": { - "CreateHyperParameterTuningJobRequest$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", - "DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", + "CreateHyperParameterTuningJobRequest$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", + "DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", "HyperParameterTuningJobSearchEntity$TrainingJobDefinitions": "

The job definitions included in a hyperparameter tuning job.

" } }, @@ -5995,14 +5996,14 @@ "HyperParameterTrainingJobSummaries": { "base": null, "refs": { - "ListTrainingJobsForHyperParameterTuningJobResponse$TrainingJobSummaries": "

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

" + "ListTrainingJobsForHyperParameterTuningJobResponse$TrainingJobSummaries": "

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

" } }, "HyperParameterTrainingJobSummary": { "base": "

The container for the summary information about a training job.

", "refs": { - "DescribeHyperParameterTuningJobResponse$BestTrainingJob": "

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

", - "DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob": "

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

", + "DescribeHyperParameterTuningJobResponse$BestTrainingJob": "

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

", + "DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob": "

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

", "HyperParameterTrainingJobSummaries$member": null, "HyperParameterTuningJobSearchEntity$BestTrainingJob": null, "HyperParameterTuningJobSearchEntity$OverallBestTrainingJob": null @@ -6048,8 +6049,8 @@ "HyperParameterTuningJobConfig": { "base": "

Configures a hyperparameter tuning job.

", "refs": { - "CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

", - "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

", + "CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

", + "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

", "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig": null } }, @@ -6078,7 +6079,7 @@ "base": "

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

", "refs": { "HyperParameterTrainingJobDefinition$TuningObjective": null, - "HyperParameterTuningJobConfig$HyperParameterTuningJobObjective": "

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

", + "HyperParameterTuningJobConfig$HyperParameterTuningJobObjective": "

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

", "HyperParameterTuningJobObjectives$member": null } }, @@ -6132,7 +6133,7 @@ "HyperParameterTuningJobSummaries": { "base": null, "refs": { - "ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries": "

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

" + "ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries": "

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

" } }, "HyperParameterTuningJobSummary": { @@ -6497,15 +6498,15 @@ "InferenceExperimentStatus": { "base": null, "refs": { - "DescribeInferenceExperimentResponse$Status": "

The status of the inference experiment. The following are the possible statuses for an inference experiment:

", + "DescribeInferenceExperimentResponse$Status": "

The status of the inference experiment. The following are the possible statuses for an inference experiment:

", "InferenceExperimentSummary$Status": "

The status of the inference experiment.

", - "ListInferenceExperimentsRequest$StatusEquals": "

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperimentResponse$Status.

" + "ListInferenceExperimentsRequest$StatusEquals": "

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.

" } }, "InferenceExperimentStatusReason": { "base": null, "refs": { - "DescribeInferenceExperimentResponse$StatusReason": "

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

", + "DescribeInferenceExperimentResponse$StatusReason": "

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

", "InferenceExperimentSummary$StatusReason": "

The error message for the inference experiment status result.

", "StopInferenceExperimentRequest$Reason": "

The reason for stopping the experiment.

" } @@ -6528,7 +6529,7 @@ "CreateInferenceExperimentRequest$Type": "

The type of the inference experiment that you want to run. The following types of experiments are possible:

", "DescribeInferenceExperimentResponse$Type": "

The type of the inference experiment.

", "InferenceExperimentSummary$Type": "

The type of the inference experiment.

", - "ListInferenceExperimentsRequest$Type": "

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperimentRequest$Type.

" + "ListInferenceExperimentsRequest$Type": "

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.

" } }, "InferenceImage": { @@ -6623,7 +6624,7 @@ "refs": { "CreateTrainingJobRequest$InputDataConfig": "

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

", "DescribeTrainingJobResponse$InputDataConfig": "

An array of Channel objects that describes each data input channel.

", - "HyperParameterTrainingJobDefinition$InputDataConfig": "

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

", + "HyperParameterTrainingJobDefinition$InputDataConfig": "

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

", "TrainingJob$InputDataConfig": "

An array of Channel objects that describes each data input channel.

", "TrainingJobDefinition$InputDataConfig": "

An array of Channel objects, each of which specifies an input source.

" } @@ -6731,7 +6732,7 @@ "IntegerParameterRanges": { "base": null, "refs": { - "ParameterRanges$IntegerParameterRanges": "

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

" + "ParameterRanges$IntegerParameterRanges": "

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

" } }, "IntegerValue": { @@ -6892,7 +6893,7 @@ "DescribeDomainResponse$KmsKeyId": "

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

", "DescribeEdgePackagingJobResponse$ResourceKey": "

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

", "DescribeEndpointConfigOutput$KmsKeyId": "

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

", - "DescribeInferenceExperimentResponse$KmsKey": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperimentRequest$KmsKey.

", + "DescribeInferenceExperimentResponse$KmsKey": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

", "DescribeNotebookInstanceOutput$KmsKeyId": "

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

", "EdgeOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

", "FlowDefinitionOutputConfig$KmsKeyId": "

The Amazon Key Management Service (KMS) key ID for server-side encryption.

", @@ -8272,7 +8273,7 @@ "base": null, "refs": { "AlgorithmSpecification$MetricDefinitions": "

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

", - "HyperParameterAlgorithmSpecification$MetricDefinitions": "

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

", + "HyperParameterAlgorithmSpecification$MetricDefinitions": "

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

", "TrainingSpecification$MetricDefinitions": "

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

" } }, @@ -8332,7 +8333,7 @@ } }, "Model": { - "base": "

The properties of a model as returned by the Search API.

", + "base": "

The properties of a model as returned by the Search API.

", "refs": { "ModelDashboardModel$Model": "

A model displayed in the Model Dashboard.

" } @@ -8416,10 +8417,10 @@ "ModelCardContent": { "base": null, "refs": { - "CreateModelCardRequest$Content": "

The content of the model card. Content must be in model card JSON schema and provided as a string.

", + "CreateModelCardRequest$Content": "

The content of the model card. Content must be in model card JSON schema and provided as a string.

", "DescribeModelCardResponse$Content": "

The content of the model card.

", - "ModelCard$Content": "

The content of the model card. Content uses the model card JSON schema and provided as a string.

", - "UpdateModelCardRequest$Content": "

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

" + "ModelCard$Content": "

The content of the model card. Content uses the model card JSON schema and provided as a string.

", + "UpdateModelCardRequest$Content": "

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

" } }, "ModelCardExportArtifacts": { @@ -8965,6 +8966,12 @@ "DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput": "

Inputs for the model quality job.

" } }, + "ModelRegisterSettings": { + "base": "

The model registry settings for the SageMaker Canvas application.

", + "refs": { + "CanvasAppSettings$ModelRegisterSettings": "

The model registry settings for the SageMaker Canvas application.

" + } + }, "ModelSortKey": { "base": null, "refs": { @@ -9529,10 +9536,10 @@ } }, "NeoVpcConfig": { - "base": "

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

", + "base": "

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

", "refs": { - "CreateCompilationJobRequest$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

", - "DescribeCompilationJobResponse$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

" + "CreateCompilationJobRequest$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

", + "DescribeCompilationJobResponse$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

" } }, "NeoVpcSecurityGroupId": { @@ -9560,7 +9567,7 @@ } }, "NestedFilters": { - "base": "

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

", + "base": "

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

", "refs": { "NestedFiltersList$member": null } @@ -9947,15 +9954,15 @@ "ObjectiveStatusCounters": { "base": "

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

", "refs": { - "DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

", + "DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

", "HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters": null, - "HyperParameterTuningJobSummary$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

" + "HyperParameterTuningJobSummary$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

" } }, "OfflineStoreConfig": { "base": "

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

", "refs": { - "CreateFeatureGroupRequest$OfflineStoreConfig": "

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

To learn more about this parameter, see OfflineStoreConfig.

", + "CreateFeatureGroupRequest$OfflineStoreConfig": "

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

To learn more about this parameter, see OfflineStoreConfig.

", "DescribeFeatureGroupResponse$OfflineStoreConfig": "

The configuration of the offline store. It includes the following configurations:

", "FeatureGroup$OfflineStoreConfig": null } @@ -10012,9 +10019,9 @@ } }, "OnlineStoreConfig": { - "base": "

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly; the default value is False.

", + "base": "

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

", "refs": { - "CreateFeatureGroupRequest$OnlineStoreConfig": "

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig; the default value is False.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

", + "CreateFeatureGroupRequest$OnlineStoreConfig": "

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

", "DescribeFeatureGroupResponse$OnlineStoreConfig": "

The configuration for the OnlineStore.

", "FeatureGroup$OnlineStoreConfig": null } @@ -10163,7 +10170,7 @@ "base": "

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.

", "refs": { "HyperParameterTrainingJobDefinition$HyperParameterRanges": null, - "HyperParameterTuningJobConfig$ParameterRanges": "

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

" + "HyperParameterTuningJobConfig$ParameterRanges": "

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

" } }, "ParameterType": { @@ -10224,7 +10231,7 @@ } }, "PendingProductionVariantSummary": { - "base": "

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

", + "base": "

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

", "refs": { "PendingProductionVariantSummaryList$member": null } @@ -10232,8 +10239,8 @@ "PendingProductionVariantSummaryList": { "base": null, "refs": { - "PendingDeploymentSummary$ProductionVariants": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

", - "PendingDeploymentSummary$ShadowProductionVariants": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

" + "PendingDeploymentSummary$ProductionVariants": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

", + "PendingDeploymentSummary$ShadowProductionVariants": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

" } }, "Percentage": { @@ -10827,8 +10834,8 @@ "ProductionVariantSummaryList": { "base": null, "refs": { - "DescribeEndpointOutput$ProductionVariants": "

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

", - "DescribeEndpointOutput$ShadowProductionVariants": "

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

", + "DescribeEndpointOutput$ProductionVariants": "

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

", + "DescribeEndpointOutput$ShadowProductionVariants": "

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

", "Endpoint$ProductionVariants": "

A list of the production variants hosted on the endpoint. Each production variant is a model.

", "Endpoint$ShadowProductionVariants": "

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

" } @@ -11223,7 +11230,7 @@ "RecommendationJobName": { "base": null, "refs": { - "CreateInferenceRecommendationsJobRequest$JobName": "

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

", + "CreateInferenceRecommendationsJobRequest$JobName": "

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

", "DescribeInferenceRecommendationsJobRequest$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", "DescribeInferenceRecommendationsJobResponse$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", "InferenceRecommendationsJob$JobName": "

The name of the job.

", @@ -11499,8 +11506,8 @@ "ResourceLimits": { "base": "

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

", "refs": { - "HyperParameterTuningJobConfig$ResourceLimits": "

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

", - "HyperParameterTuningJobSummary$ResourceLimits": "

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

" + "HyperParameterTuningJobConfig$ResourceLimits": "

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

", + "HyperParameterTuningJobSummary$ResourceLimits": "

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

" } }, "ResourceNotFound": { @@ -11517,7 +11524,7 @@ "ResourcePropertyName": { "base": null, "refs": { - "Filter$Name": "

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

", + "Filter$Name": "

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

", "NestedFilters$NestedPropertyName": "

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

", "PropertyNameSuggestion$PropertyName": "

A suggested property name based on what you entered in the search textbox in the SageMaker console.

", "SearchRequest$SortBy": "

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

" @@ -11617,7 +11624,7 @@ "CreatePipelineRequest$RoleArn": "

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

", "CreateProcessingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", "CreateTrainingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

", - "DefaultSpaceSettings$ExecutionRole": "

The execution role for the space.

", + "DefaultSpaceSettings$ExecutionRole": "

The ARN of the execution role for the space.

", "DescribeAutoMLJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", "DescribeAutoMLJobV2Response$RoleArn": "

The ARN of the Identity and Access Management role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", "DescribeCompilationJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

", @@ -11644,6 +11651,7 @@ "InferenceRecommendationsJob$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", "Model$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

", "ModelPackageValidationSpecification$ValidationRole": "

The IAM roles to be used for the validation of the model package.

", + "ModelRegisterSettings$CrossAccountModelRegisterRoleArn": "

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas AWS account than the AWS account in which SageMaker model registry is set up.

", "MonitoringJobDefinition$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", "Pipeline$RoleArn": "

The Amazon Resource Name (ARN) of the role that created the pipeline.

", "PipelineSummary$RoleArn": "

The Amazon Resource Name (ARN) that the pipeline used to execute.

", @@ -11652,7 +11660,7 @@ "RStudioServerProDomainSettingsForUpdate$DomainExecutionRoleArn": "

The execution role for the RStudioServerPro Domain-level app.

", "RedshiftDatasetDefinition$ClusterRoleArn": "

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

", "RenderUiTemplateRequest$RoleArn": "

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

", - "TimeSeriesForecastingSettings$AmazonForecastRoleArn": "

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

", + "TimeSeriesForecastingSettings$AmazonForecastRoleArn": "

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

", "TrainingJob$RoleArn": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

", "UpdateDeviceFleetRequest$RoleArn": "

The Amazon Resource Name (ARN) of the device.

", "UpdateImageRequest$RoleArn": "

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", @@ -11846,7 +11854,7 @@ } }, "SearchRecord": { - "base": "

A single resource returned as part of the Search API response.

", + "base": "

A single resource returned as part of the Search API response.

", "refs": { "SearchResultsList$member": null } @@ -11876,13 +11884,13 @@ "SecondaryStatus": { "base": null, "refs": { - "DescribeTrainingJobResponse$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

", + "DescribeTrainingJobResponse$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

", "SecondaryStatusTransition$Status": "

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress
Completed
Failed
Stopped
Stopping

We no longer support the following secondary statuses:

", - "TrainingJob$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

" + "TrainingJob$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

" } }, "SecondaryStatusTransition": { - "base": "

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

", + "base": "

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

", "refs": { "SecondaryStatusTransitions$member": null } @@ -11914,9 +11922,9 @@ "base": null, "refs": { "CreateNotebookInstanceInput$SecurityGroupIds": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

", - "DefaultSpaceSettings$SecurityGroups": "

The security groups for the Amazon Virtual Private Cloud that the space uses for communication.

", + "DefaultSpaceSettings$SecurityGroups": "

The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

", "DescribeNotebookInstanceOutput$SecurityGroups": "

The IDs of the VPC security groups.

", - "UserSettings$SecurityGroups": "

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

" + "UserSettings$SecurityGroups": "

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

" } }, "Seed": { @@ -12336,7 +12344,7 @@ "StatusMessage": { "base": null, "refs": { - "SecondaryStatusTransition$StatusMessage": "

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting
Training

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

" + "SecondaryStatusTransition$StatusMessage": "

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting
Training

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

" } }, "StepDescription": { @@ -12749,7 +12757,7 @@ } }, "SuggestionQuery": { - "base": "

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

", + "base": "

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

", "refs": { "GetSearchSuggestionsRequest$SuggestionQuery": "

Limits the property names that are included in the response.

" } @@ -12767,7 +12775,7 @@ } }, "Tag": { - "base": "

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

", + "base": "

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

", "refs": { "TagList$member": null } @@ -12807,7 +12815,7 @@ "CreateEdgePackagingJobRequest$Tags": "

Creates tags for the packaging job.

", "CreateEndpointConfigInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", "CreateEndpointInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateExperimentRequest$Tags": "

A list of tags to associate with the experiment. You can use Search API to search on the tags.

", + "CreateExperimentRequest$Tags": "

A list of tags to associate with the experiment. You can use Search API to search on the tags.

", "CreateFeatureGroupRequest$Tags": "

Tags used to identify Features in each FeatureGroup.

", "CreateFlowDefinitionRequest$Tags": "

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

", "CreateHubRequest$Tags": "

Any tags to associate with the hub.

", @@ -12833,14 +12841,14 @@ "CreateStudioLifecycleConfigRequest$Tags": "

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

", "CreateTrainingJobRequest$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", "CreateTransformJobRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateTrialComponentRequest$Tags": "

A list of tags to associate with the component. You can use Search API to search on the tags.

", - "CreateTrialRequest$Tags": "

A list of tags to associate with the trial. You can use Search API to search on the tags.

", + "CreateTrialComponentRequest$Tags": "

A list of tags to associate with the component. You can use Search API to search on the tags.

", + "CreateTrialRequest$Tags": "

A list of tags to associate with the trial. You can use Search API to search on the tags.

", "CreateUserProfileRequest$Tags": "

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

", "CreateWorkforceRequest$Tags": "

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

", "CreateWorkteamRequest$Tags": "

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", "DescribeLabelingJobResponse$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", "Endpoint$Tags": "

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "Experiment$Tags": "

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

", + "Experiment$Tags": "

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

", "FeatureGroup$Tags": "

Tags used to define a FeatureGroup.

", "HyperParameterTuningJobSearchEntity$Tags": "

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

", "ImportHubContentRequest$Tags": "

Any tags associated with the hub content.

", @@ -12857,8 +12865,8 @@ "RegisterDevicesRequest$Tags": "

The tags associated with devices.

", "TrainingJob$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", "TransformJob$Tags": "

A list of tags associated with the transform job.

", - "Trial$Tags": "

The list of tags that are associated with the trial. You can use Search API to search on the tags.

", - "TrialComponent$Tags": "

The list of tags that are associated with the component. You can use Search API to search on the tags.

", + "Trial$Tags": "

The list of tags that are associated with the trial. You can use Search API to search on the tags.

", + "TrialComponent$Tags": "

The list of tags that are associated with the component. You can use Search API to search on the tags.

", "UpdateProjectInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

" } }, @@ -12878,7 +12886,7 @@ "base": null, "refs": { "CompilationJobSummary$CompilationTargetDevice": "

The type of device that the model will run on after the compilation job has completed.

", - "OutputConfig$TargetDevice": "

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

" + "OutputConfig$TargetDevice": "

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

" } }, "TargetLabelColumn": { @@ -12931,7 +12939,7 @@ "refs": { "DesiredWeightAndCapacity$DesiredInstanceCount": "

The variant's capacity.

", "PendingProductionVariantSummary$CurrentInstanceCount": "

The number of instances associated with the variant.

", - "PendingProductionVariantSummary$DesiredInstanceCount": "

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

", + "PendingProductionVariantSummary$DesiredInstanceCount": "

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

", "ProductionVariantSummary$CurrentInstanceCount": "

The number of instances associated with the variant.

", "ProductionVariantSummary$DesiredInstanceCount": "

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

", "RealTimeInferenceConfig$InstanceCount": "

The number of instances of the type specified by InstanceType.

" @@ -13032,9 +13040,9 @@ } }, "TimeSeriesForecastingSettings": { - "base": "

Time series forecast settings for the SageMaker Canvas app.

", + "base": "

Time series forecast settings for the SageMaker Canvas application.

", "refs": { - "CanvasAppSettings$TimeSeriesForecastingSettings": "

Time series forecast settings for the Canvas app.

" + "CanvasAppSettings$TimeSeriesForecastingSettings": "

Time series forecast settings for the Canvas application.

" } }, "Timestamp": { @@ -13075,7 +13083,7 @@ "DescribeAutoMLJobV2Response$CreationTime": "

Returns the creation time of the AutoML V2 job.

", "DescribeAutoMLJobV2Response$EndTime": "

Returns the end time of the AutoML V2 job.

", "DescribeAutoMLJobV2Response$LastModifiedTime": "

Returns the job's last modified time.

", - "DescribeCompilationJobResponse$CompilationStartTime": "

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

", + "DescribeCompilationJobResponse$CompilationStartTime": "

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

", "DescribeCompilationJobResponse$CompilationEndTime": "

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

", "DescribeContextResponse$CreationTime": "

When the context was created.

", "DescribeContextResponse$LastModifiedTime": "

When the context was last modified.

", @@ -13423,7 +13431,7 @@ "TrialSummary$LastModifiedTime": "

When the trial was last modified.

", "UpdateTrialComponentRequest$StartTime": "

When the component started.

", "UpdateTrialComponentRequest$EndTime": "

When the component ended.

", - "Workforce$LastUpdatedDate": "

The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

", + "Workforce$LastUpdatedDate": "

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

", "Workforce$CreateDate": "

The date that the workforce is created.

", "Workteam$CreateDate": "

The date and time that the work team was created (timestamp).

", "Workteam$LastUpdatedDate": "

The date and time that the work team was last updated (timestamp).

" @@ -13513,7 +13521,7 @@ "base": "

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

", "refs": { "AlgorithmSpecification$TrainingInputMode": null, - "Channel$InputMode": "

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

", + "Channel$InputMode": "

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

", "HyperParameterAlgorithmSpecification$TrainingInputMode": null, "InputModes$member": null, "TrainingJobDefinition$TrainingInputMode": null @@ -13621,9 +13629,9 @@ "TrainingJobStatusCounters": { "base": "

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

", "refs": { - "DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

", + "DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

", "HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters": null, - "HyperParameterTuningJobSummary$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

" + "HyperParameterTuningJobSummary$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

" } }, "TrainingJobStepMetadata": { @@ -13789,7 +13797,7 @@ } }, "TransformJobSummary": { - "base": "

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

", + "base": "

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

", "refs": { "TransformJobSummaries$member": null } @@ -13819,7 +13827,7 @@ } }, "Trial": { - "base": "

The properties of a trial as returned by the Search API.

", + "base": "

The properties of a trial as returned by the Search API.

", "refs": { "SearchRecord$Trial": "

The properties of a trial.

" } @@ -13838,7 +13846,7 @@ } }, "TrialComponent": { - "base": "

The properties of a trial component as returned by the Search API.

", + "base": "

The properties of a trial component as returned by the Search API.

", "refs": { "SearchRecord$TrialComponent": "

The properties of a trial component.

" } @@ -13858,7 +13866,7 @@ } }, "TrialComponentArtifact": { - "base": "

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

", + "base": "

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

", "refs": { "TrialComponentArtifacts$value": null } @@ -13909,7 +13917,7 @@ } }, "TrialComponentParameterValue": { - "base": "

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

", + "base": "

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

", "refs": { "TrialComponentParameters$value": null } @@ -13994,7 +14002,7 @@ } }, "TrialComponentSummary": { - "base": "

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

", + "base": "

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

", "refs": { "TrialComponentSummaries$member": null } @@ -14020,7 +14028,7 @@ } }, "TrialSummary": { - "base": "

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

", + "base": "

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

", "refs": { "TrialSummaries$member": null } @@ -14526,7 +14534,7 @@ } }, "VariantProperty": { - "base": "

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties option set to true, the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties override the existing variant properties of the endpoint.

", + "base": "

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

", "refs": { "VariantPropertyList$member": null } @@ -14534,13 +14542,13 @@ "VariantPropertyList": { "base": null, "refs": { - "UpdateEndpointInput$ExcludeRetainedVariantProperties": "

When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

" + "UpdateEndpointInput$ExcludeRetainedVariantProperties": "

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

" } }, "VariantPropertyType": { "base": null, "refs": { - "VariantProperty$VariantPropertyType": "

The type of variant property. The supported values are:

" + "VariantProperty$VariantPropertyType": "

The type of variant property. The supported values are:

" } }, "VariantStatus": { @@ -14560,7 +14568,7 @@ "refs": { "DesiredWeightAndCapacity$DesiredWeight": "

The variant's weight.

", "PendingProductionVariantSummary$CurrentWeight": "

The weight associated with the variant.

", - "PendingProductionVariantSummary$DesiredWeight": "

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

", + "PendingProductionVariantSummary$DesiredWeight": "

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

", "ProductionVariant$InitialVariantWeight": "

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

", "ProductionVariantSummary$CurrentWeight": "

The weight associated with the variant.

", "ProductionVariantSummary$DesiredWeight": "

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

" @@ -14611,16 +14619,16 @@ "base": "

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", "refs": { "AutoMLSecurityConfig$VpcConfig": "

The VPC configuration.

", - "CreateModelInput$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

", - "CreateTrainingJobRequest$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", - "DescribeModelOutput$VpcConfig": "

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

", - "DescribeTrainingJobResponse$VpcConfig": "

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", - "HyperParameterTrainingJobDefinition$VpcConfig": "

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", + "CreateModelInput$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

", + "CreateTrainingJobRequest$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", + "DescribeModelOutput$VpcConfig": "

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

", + "DescribeTrainingJobResponse$VpcConfig": "

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", + "HyperParameterTrainingJobDefinition$VpcConfig": "

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", "LabelingJobResourceConfig$VpcConfig": null, "Model$VpcConfig": null, "MonitoringNetworkConfig$VpcConfig": null, "NetworkConfig$VpcConfig": null, - "TrainingJob$VpcConfig": "

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" + "TrainingJob$VpcConfig": "

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" } }, "VpcId": { @@ -14686,7 +14694,7 @@ "DeleteWorkforceRequest$WorkforceName": "

The name of the workforce.

", "DescribeWorkforceRequest$WorkforceName": "

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

", "ListWorkforcesRequest$NameContains": "

A filter you can use to search for workforces using part of the workforce name.

", - "UpdateWorkforceRequest$WorkforceName": "

The name of the private workforce that you want to update. You can find your workforce name by using the operation.

", + "UpdateWorkforceRequest$WorkforceName": "

The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.

", "Workforce$WorkforceName": "

The name of the private workforce.

" } }, diff --git a/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json b/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json index 7c3aaa3856..4a1c50b294 100644 --- a/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json +++ b/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json @@ -8,8 +8,8 @@ } }, "params": { - "UseFIPS": false, "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -21,8 +21,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -34,8 +34,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -47,8 +47,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -60,8 +60,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -73,8 +73,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -86,8 +86,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -99,8 +99,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -112,8 +112,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -125,8 +125,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -138,8 +138,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -151,8 +151,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -164,8 +164,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -177,8 +177,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -190,8 +190,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -203,8 +203,8 @@ } }, "params": { - "UseFIPS": false, "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -216,8 +216,8 @@ } }, "params": { - "UseFIPS": false, "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -229,8 +229,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -242,8 +242,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -255,8 +255,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -268,8 +268,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -281,8 +281,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -294,8 +294,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -307,8 +307,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -320,8 +320,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -333,8 +333,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -346,8 +346,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -359,8 +359,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -372,8 +372,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-northwest-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -385,8 +385,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -398,8 +398,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -411,8 +411,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -424,8 +424,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -437,8 +437,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -450,8 +450,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -463,8 +463,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -476,8 +476,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -489,8 +489,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -502,8 +502,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -513,8 +513,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -526,8 +526,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -537,8 +537,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -548,8 +548,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -561,8 +561,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -572,8 +572,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -585,8 +585,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -598,8 +598,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -623,8 +623,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -635,8 +635,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } diff --git a/models/apis/snowball/2016-06-30/api-2.json b/models/apis/snowball/2016-06-30/api-2.json index 141713e438..18e687031c 100755 --- a/models/apis/snowball/2016-06-30/api-2.json +++ b/models/apis/snowball/2016-06-30/api-2.json @@ -512,9 +512,7 @@ "type":"structure", "required":[ "JobType", - "Resources", "AddressId", - "RoleARN", "SnowballType", "ShippingOption" ], @@ -531,13 +529,18 @@ "Notification":{"shape":"Notification"}, "ForwardingAddressId":{"shape":"AddressId"}, "TaxDocuments":{"shape":"TaxDocuments"}, - "RemoteManagement":{"shape":"RemoteManagement"} + "RemoteManagement":{"shape":"RemoteManagement"}, + "InitialClusterSize":{"shape":"InitialClusterSize"}, + "ForceCreateJobs":{"shape":"Boolean"}, + "LongTermPricingIds":{"shape":"LongTermPricingIdList"}, + "SnowballCapacityPreference":{"shape":"SnowballCapacity"} } }, "CreateClusterResult":{ "type":"structure", "members":{ - "ClusterId":{"shape":"ClusterId"} + "ClusterId":{"shape":"ClusterId"}, + "JobListEntries":{"shape":"JobListEntryList"} } }, "CreateJobRequest":{ @@ -798,6 +801,11 @@ "GSTIN":{"shape":"GSTIN"} } }, + "InitialClusterSize":{ + "type":"integer", + "max":16, + "min":0 + }, "Integer":{"type":"integer"}, "InvalidAddressException":{ "type":"structure", @@ -1080,6 +1088,10 @@ "min":41, "pattern":"LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, + "LongTermPricingIdList":{ + "type":"list", + "member":{"shape":"LongTermPricingId"} + }, "LongTermPricingListEntry":{ "type":"structure", "members":{ @@ -1099,7 +1111,8 @@ "type":"string", "enum":[ "OneYear", - "ThreeYear" + "ThreeYear", + "OneMonth" ] }, "NFSOnDeviceServiceConfiguration":{ @@ -1109,6 +1122,11 @@ "StorageUnit":{"shape":"StorageUnit"} } }, + "NodeFaultTolerance":{ + "type":"integer", + "max":4, + "min":1 + }, "Notification":{ "type":"structure", "members":{ @@ -1122,7 +1140,8 @@ "members":{ "NFSOnDeviceService":{"shape":"NFSOnDeviceServiceConfiguration"}, "TGWOnDeviceService":{"shape":"TGWOnDeviceServiceConfiguration"}, - "EKSOnDeviceService":{"shape":"EKSOnDeviceServiceConfiguration"} + "EKSOnDeviceService":{"shape":"EKSOnDeviceServiceConfiguration"}, + "S3OnDeviceService":{"shape":"S3OnDeviceServiceConfiguration"} } }, "RemoteManagement":{ @@ -1149,6 +1168,15 @@ "max":255, "pattern":"arn:aws.*:iam::[0-9]{12}:role/.*" }, + "S3OnDeviceServiceConfiguration":{ + "type":"structure", + "members":{ + "StorageLimit":{"shape":"S3StorageLimit"}, + "StorageUnit":{"shape":"StorageUnit"}, + "ServiceSize":{"shape":"ServiceSize"}, + "FaultTolerance":{"shape":"NodeFaultTolerance"} + } + }, "S3Resource":{ "type":"structure", "members":{ @@ -1161,6 +1189,10 @@ "type":"list", "member":{"shape":"S3Resource"} }, + "S3StorageLimit":{ + "type":"double", + "min":0.0 + }, "ServiceName":{ "type":"string", "enum":[ @@ -1168,6 +1200,11 @@ "EKS_ANYWHERE" ] }, + "ServiceSize":{ + "type":"integer", + "max":16, + "min":3 + }, "ServiceVersion":{ "type":"structure", "members":{ @@ -1229,7 +1266,8 @@ "T8", "T14", "T32", - "NoPreference" + "NoPreference", + "T240" ] }, "SnowballType":{ @@ -1242,7 +1280,8 @@ "EDGE_S", "SNC1_HDD", "SNC1_SSD", - "V3_5C" + "V3_5C", + "V3_5S" ] }, "SnowconeDeviceConfiguration":{ diff --git a/models/apis/snowball/2016-06-30/docs-2.json b/models/apis/snowball/2016-06-30/docs-2.json index d8d728c6b5..137d1e0c29 100755 --- a/models/apis/snowball/2016-06-30/docs-2.json +++ b/models/apis/snowball/2016-06-30/docs-2.json @@ -6,7 +6,7 @@ "CancelJob": "

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

", "CreateAddress": "

Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

", "CreateCluster": "

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

", - "CreateJob": "

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Only the Snowball; Edge device type is supported when ordering clustered jobs.

The device capacity is optional.

Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.

Snow Family devices and their capacities.

", + "CreateJob": "

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Only the Snowball; Edge device type is supported when ordering clustered jobs.

The device capacity is optional.

Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.

Snow Family devices and their capacities.

", "CreateLongTermPricing": "

Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.

", "CreateReturnShippingLabel": "

Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

", "DescribeAddress": "

Takes an AddressId and returns specific details about that address in the form of an Address object.

", @@ -20,7 +20,7 @@ "GetSoftwareUpdates": "

Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

", "ListClusterJobs": "

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

", "ListClusters": "

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

", - "ListCompatibleImages": "

This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the Amazon Web Services Marketplace.

", + "ListCompatibleImages": "

This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.

", "ListJobs": "

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

", "ListLongTermPricing": "

Lists all long-term pricing types.

", "ListServiceVersions": "

Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.

", @@ -73,6 +73,7 @@ "base": null, "refs": { "Address$IsRestricted": "

If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

", + "CreateClusterRequest$ForceCreateJobs": "

Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with OnDeviceServiceConfiguration.

", "JobListEntry$IsMaster": "

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

", "Notification$NotifyAll": "

Any change in job state will trigger a notification for this job.

", "WirelessConnection$IsWifiEnabled": "

Enables the Wi-Fi adapter on an Snowcone device.

" @@ -307,7 +308,7 @@ } }, "Ec2RequestFailedException": { - "base": "

Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.

", + "base": "

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

", "refs": { } }, @@ -375,6 +376,12 @@ "TaxDocuments$IND": null } }, + "InitialClusterSize": { + "base": null, + "refs": { + "CreateClusterRequest$InitialClusterSize": "

If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

" + } + }, "Integer": { "base": null, "refs": { @@ -443,6 +450,7 @@ "JobListEntryList": { "base": null, "refs": { + "CreateClusterResult$JobListEntries": "

List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.

", "ListClusterJobsResult$JobListEntries": "

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

", "ListJobsResult$JobListEntries": "

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

" } @@ -632,10 +640,17 @@ "CreateJobRequest$LongTermPricingId": "

The ID of the long-term pricing type for the device.

", "CreateLongTermPricingResult$LongTermPricingId": "

The ID of the long-term pricing type for the device.

", "JobMetadata$LongTermPricingId": "

The ID of the long-term pricing type for the device.

", + "LongTermPricingIdList$member": null, "LongTermPricingListEntry$LongTermPricingId": "

The ID of the long-term pricing type for the device.

", "UpdateLongTermPricingRequest$LongTermPricingId": "

The ID of the long-term pricing type for the device.

" } }, + "LongTermPricingIdList": { + "base": null, + "refs": { + "CreateClusterRequest$LongTermPricingIds": "

Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

" + } + }, "LongTermPricingListEntry": { "base": "

Each LongTermPricingListEntry object contains information about a long-term pricing type.

", "refs": { @@ -655,6 +670,12 @@ "OnDeviceServiceConfiguration$NFSOnDeviceService": "

Represents the NFS (Network File System) service on a Snow Family device.

" } }, + "NodeFaultTolerance": { + "base": null, + "refs": { + "S3OnDeviceServiceConfiguration$FaultTolerance": "

>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

" + } + }, "Notification": { "base": "

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

", "refs": { @@ -709,6 +730,12 @@ "UpdateJobRequest$RoleARN": "

The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.

" } }, + "S3OnDeviceServiceConfiguration": { + "base": "

Amazon S3 compatible storage on Snow family devices configuration items.

", + "refs": { + "OnDeviceServiceConfiguration$S3OnDeviceService": "

Configuration for Amazon S3 compatible storage on Snow family devices.

" + } + }, "S3Resource": { "base": "

Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

", "refs": { @@ -721,6 +748,12 @@ "JobResource$S3Resources": "

An array of S3Resource objects.

" } }, + "S3StorageLimit": { + "base": null, + "refs": { + "S3OnDeviceServiceConfiguration$StorageLimit": "

If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

" + } + }, "ServiceName": { "base": null, "refs": { @@ -729,6 +762,12 @@ "ListServiceVersionsResult$ServiceName": "

The name of the service for which the system provided supported versions.

" } }, + "ServiceSize": { + "base": null, + "refs": { + "S3OnDeviceServiceConfiguration$ServiceSize": "

Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

" + } + }, "ServiceVersion": { "base": "

The version of the requested service.

", "refs": { @@ -783,6 +822,7 @@ "SnowballCapacity": { "base": null, "refs": { + "CreateClusterRequest$SnowballCapacityPreference": "

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

For more information, see \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide or \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide.

", "CreateJobRequest$SnowballCapacityPreference": "

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

For more information, see \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide or \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide.

", "JobMetadata$SnowballCapacityPreference": "

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

For more information, see \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide or \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide.

", "UpdateJobRequest$SnowballCapacityPreference": "

The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

For more information, see \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide or \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow Family Devices and Capacity) in the Snowcone User Guide.

" @@ -823,6 +863,7 @@ "base": null, "refs": { "NFSOnDeviceServiceConfiguration$StorageUnit": "

The scale unit of the NFS storage on the device.

Valid values: TB.

", + "S3OnDeviceServiceConfiguration$StorageUnit": "

Storage unit. Currently the only supported unit is TB.

", "TGWOnDeviceServiceConfiguration$StorageUnit": "

The scale unit of the virtual tapes on the device.

" } }, diff --git a/models/apis/snowball/2016-06-30/endpoint-tests-1.json b/models/apis/snowball/2016-06-30/endpoint-tests-1.json index aa78733229..2d7e84493d 100644 --- a/models/apis/snowball/2016-06-30/endpoint-tests-1.json +++ b/models/apis/snowball/2016-06-30/endpoint-tests-1.json @@ -9,8 +9,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -22,8 +22,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -35,8 +35,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -48,8 +48,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -61,8 +61,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -74,8 +74,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -87,8 +87,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -100,8 +100,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -113,8 +113,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -126,8 +126,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -139,8 +139,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -152,8 +152,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -165,8 +165,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -178,8 +178,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -191,8 +191,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -204,8 +204,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -217,8 +217,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -230,8 +230,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -243,8 +243,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -256,8 +256,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -269,8 +269,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -282,8 +282,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -295,8 +295,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -308,8 +308,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -321,8 +321,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -334,8 +334,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -347,8 +347,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -360,8 +360,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -373,8 +373,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -386,8 +386,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -399,8 +399,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -412,8 +412,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -425,8 +425,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -438,8 +438,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -451,8 +451,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -464,8 +464,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -477,8 +477,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -490,8 +490,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -503,8 +503,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -516,8 +516,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -529,8 +529,8 @@ }, "params": { "Region": "cn-northwest-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -542,8 +542,8 @@ }, "params": { "Region": "cn-northwest-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -555,8 +555,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -568,8 +568,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -581,8 +581,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -594,8 +594,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -607,8 +607,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -620,8 +620,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -633,8 +633,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -646,8 +646,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -659,8 +659,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -672,8 +683,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -685,8 +707,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -698,8 +731,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -711,8 +755,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -724,8 +768,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -736,8 +780,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -748,10 +792,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/wafv2/2019-07-29/api-2.json b/models/apis/wafv2/2019-07-29/api-2.json index c56ad7249a..902a0e48ec 100755 --- a/models/apis/wafv2/2019-07-29/api-2.json +++ b/models/apis/wafv2/2019-07-29/api-2.json @@ -49,6 +49,21 @@ {"shape":"WAFInvalidOperationException"} ] }, + "CreateAPIKey":{ + "name":"CreateAPIKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAPIKeyRequest"}, + "output":{"shape":"CreateAPIKeyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, "CreateIPSet":{ "name":"CreateIPSet", "http":{ @@ -303,6 +318,21 @@ {"shape":"WAFInvalidOperationException"} ] }, + "GetDecryptedAPIKey":{ + "name":"GetDecryptedAPIKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDecryptedAPIKeyRequest"}, + "output":{"shape":"GetDecryptedAPIKeyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidResourceException"} + ] + }, "GetIPSet":{ "name":"GetIPSet", "http":{ @@ -467,6 +497,21 @@ {"shape":"WAFInvalidOperationException"} ] }, + "ListAPIKeys":{ + "name":"ListAPIKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAPIKeysRequest"}, + "output":{"shape":"ListAPIKeysResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidResourceException"} + ] + }, "ListAvailableManagedRuleGroupVersions":{ "name":"ListAvailableManagedRuleGroupVersions", "http":{ @@ -809,6 +854,34 @@ } }, "shapes":{ + "APIKey":{ + "type":"string", + "max":2048, + "min":1, + "pattern":".*\\S.*" + }, + "APIKeySummaries":{ + "type":"list", + "member":{"shape":"APIKeySummary"} + }, + "APIKeySummary":{ + "type":"structure", + "members":{ + "TokenDomains":{"shape":"TokenDomains"}, + "APIKey":{"shape":"APIKey"}, + "CreationTimestamp":{"shape":"Timestamp"}, + "Version":{"shape":"APIKeyVersion"} + } + }, + "APIKeyTokenDomains":{ + "type":"list", + "member":{"shape":"TokenDomain"}, + "min":1 + }, + "APIKeyVersion":{ + "type":"integer", + "min":0 + }, "AWSManagedRulesATPRuleSet":{ "type":"structure", "required":["LoginPath"], @@ -1311,6 +1384,23 @@ "member":{"shape":"CountryCode"}, "min":1 }, + "CreateAPIKeyRequest":{ + "type":"structure", + "required":[ + "Scope", + "TokenDomains" + ], + "members":{ + "Scope":{"shape":"Scope"}, + "TokenDomains":{"shape":"APIKeyTokenDomains"} + } + }, + "CreateAPIKeyResponse":{ + "type":"structure", + "members":{ + "APIKey":{"shape":"APIKey"} + } + }, "CreateIPSetRequest":{ "type":"structure", "required":[ @@ -1832,6 +1922,24 @@ "ForwardedIPConfig":{"shape":"ForwardedIPConfig"} } }, + "GetDecryptedAPIKeyRequest":{ + "type":"structure", + "required":[ + "Scope", + "APIKey" + ], + "members":{ + "Scope":{"shape":"Scope"}, + "APIKey":{"shape":"APIKey"} + } + }, + "GetDecryptedAPIKeyResponse":{ + "type":"structure", + "members":{ + "TokenDomains":{"shape":"TokenDomains"}, + "CreationTimestamp":{"shape":"Timestamp"} + } + }, "GetIPSetRequest":{ "type":"structure", "required":[ @@ -2268,6 +2376,23 @@ "type":"list", "member":{"shape":"Label"} }, + "ListAPIKeysRequest":{ + "type":"structure", + "required":["Scope"], + "members":{ + "Scope":{"shape":"Scope"}, + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListAPIKeysResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "APIKeySummaries":{"shape":"APIKeySummaries"}, + "ApplicationIntegrationURL":{"shape":"OutputUrl"} + } + }, "ListAvailableManagedRuleGroupVersionsRequest":{ "type":"structure", "required":[ diff --git a/models/apis/wafv2/2019-07-29/docs-2.json b/models/apis/wafv2/2019-07-29/docs-2.json index 1c4486a7f3..91060b51b4 100755 --- a/models/apis/wafv2/2019-07-29/docs-2.json +++ b/models/apis/wafv2/2019-07-29/docs-2.json @@ -4,6 +4,7 @@ "operations": { "AssociateWebACL": "

Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

", "CheckCapacity": "

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

", + "CreateAPIKey": "

Creates an API key for use in the integration of the CAPTCHA API in your JavaScript client applications. The integration lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

The CAPTCHA API requires a key that authorizes CAPTCHA use from the client application domain. You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.

", "CreateIPSet": "

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

", "CreateRegexPatternSet": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

", "CreateRuleGroup": "

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

", @@ -18,6 +19,7 @@ "DescribeManagedRuleGroup": "

Provides high-level information for a managed rule group, including descriptions of the rules.

", "DisassociateWebACL": "

Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

", "GenerateMobileSdkReleaseUrl": "

Generates a presigned download URL for the specified release of the mobile SDK.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

", + "GetDecryptedAPIKey": "

Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

", "GetIPSet": "

Retrieves the specified IPSet.

", "GetLoggingConfiguration": "

Returns the LoggingConfiguration for the specified web ACL.

", "GetManagedRuleSet": "

Retrieves the specified managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

", @@ -29,6 +31,7 @@ "GetSampledRequests": "

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.

", "GetWebACL": "

Retrieves the specified WebACL.

", "GetWebACLForResource": "

Retrieves the WebACL for the specified resource.

", + "ListAPIKeys": "

Retrieves a list of the API keys that you've defined for the specified scope.

", "ListAvailableManagedRuleGroupVersions": "

Returns a list of the available versions for the specified managed rule group.

", "ListAvailableManagedRuleGroups": "

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.

", "ListIPSets": "

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

", @@ -52,6 +55,38 @@ "UpdateWebACL": "

Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

To modify a web ACL, do the following:

  1. Retrieve it by calling GetWebACL

  2. Update its settings as needed

  3. Provide the complete web ACL specification to this call

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

" }, "shapes": { + "APIKey": { + "base": null, + "refs": { + "APIKeySummary$APIKey": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

For information about how to use this in your CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

", + "CreateAPIKeyResponse$APIKey": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

For information about how to use this in your CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

", + "GetDecryptedAPIKeyRequest$APIKey": "

The encrypted API key.

" + } + }, + "APIKeySummaries": { + "base": null, + "refs": { + "ListAPIKeysResponse$APIKeySummaries": "

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "APIKeySummary": { + "base": "

Information for a single API key.

", + "refs": { + "APIKeySummaries$member": null + } + }, + "APIKeyTokenDomains": { + "base": null, + "refs": { + "CreateAPIKeyRequest$TokenDomains": "

The client application domains that you want to use this API key for.

" + } + }, + "APIKeyVersion": { + "base": null, + "refs": { + "APIKeySummary$Version": "

Internal value used by WAF to manage the key.

" + } + }, "AWSManagedRulesATPRuleSet": { "base": "

Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

", "refs": { @@ -299,6 +334,16 @@ "GeoMatchStatement$CountryCodes": "

An array of two-character country codes that you want to match against, for example, [ \"US\", \"CN\" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.

" } }, + "CreateAPIKeyRequest": { + "base": null, + "refs": { + } + }, + "CreateAPIKeyResponse": { + "base": null, + "refs": { + } + }, "CreateIPSetRequest": { "base": null, "refs": { @@ -782,6 +827,16 @@ "Statement$GeoMatchStatement": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>.

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>.

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" } }, + "GetDecryptedAPIKeyRequest": { + "base": null, + "refs": { + } + }, + "GetDecryptedAPIKeyResponse": { + "base": null, + "refs": { + } + }, "GetIPSetRequest": { "base": null, "refs": { @@ -998,7 +1053,7 @@ "IPSetSummaries": { "base": null, "refs": { - "ListIPSetsResponse$IPSets": "

Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

" + "ListIPSetsResponse$IPSets": "

Array of IPSets. If you specified a Limit in your request, this might not be the full list.

" } }, "IPSetSummary": { @@ -1122,6 +1177,16 @@ "SampledHTTPRequest$Labels": "

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" } }, + "ListAPIKeysRequest": { + "base": null, + "refs": { + } + }, + "ListAPIKeysResponse": { + "base": null, + "refs": { + } + }, "ListAvailableManagedRuleGroupVersionsRequest": { "base": null, "refs": { @@ -1289,7 +1354,7 @@ "LoggingConfigurations": { "base": null, "refs": { - "ListLoggingConfigurationsResponse$LoggingConfigurations": "

" + "ListLoggingConfigurationsResponse$LoggingConfigurations": "

Array of logging configurations. If you specified a Limit in your request, this might not be the full list.

" } }, "LoggingFilter": { @@ -1326,7 +1391,7 @@ "ManagedRuleGroupSummaries": { "base": null, "refs": { - "ListAvailableManagedRuleGroupsResponse$ManagedRuleGroups": "

" + "ListAvailableManagedRuleGroupsResponse$ManagedRuleGroups": "

Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list.

" } }, "ManagedRuleGroupSummary": { @@ -1344,7 +1409,7 @@ "ManagedRuleGroupVersions": { "base": null, "refs": { - "ListAvailableManagedRuleGroupVersionsResponse$Versions": "

The versions that are currently available for the specified managed rule group.

" + "ListAvailableManagedRuleGroupVersionsResponse$Versions": "

The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.

" } }, "ManagedRuleSet": { @@ -1356,7 +1421,7 @@ "ManagedRuleSetSummaries": { "base": null, "refs": { - "ListManagedRuleSetsResponse$ManagedRuleSets": "

Your managed rule sets.

" + "ListManagedRuleSetsResponse$ManagedRuleSets": "

Your managed rule sets. If you specified a Limit in your request, this might not be the full list.

" } }, "ManagedRuleSetSummary": { @@ -1400,6 +1465,8 @@ "NextMarker": { "base": null, "refs": { + "ListAPIKeysRequest$NextMarker": "

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

", + "ListAPIKeysResponse$NextMarker": "

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

", "ListAvailableManagedRuleGroupVersionsRequest$NextMarker": "

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

", "ListAvailableManagedRuleGroupVersionsResponse$NextMarker": "

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

", "ListAvailableManagedRuleGroupsRequest$NextMarker": "

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

", @@ -1443,7 +1510,8 @@ "OutputUrl": { "base": null, "refs": { - "GetWebACLResponse$ApplicationIntegrationURL": "

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.

" + "GetWebACLResponse$ApplicationIntegrationURL": "

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.

", + "ListAPIKeysResponse$ApplicationIntegrationURL": "

The CAPTCHA application integration URL, for use in your JavaScript implementation.

For information about how to use this in your CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" } }, "OverrideAction": { @@ -1465,6 +1533,7 @@ "PaginationLimit": { "base": null, "refs": { + "ListAPIKeysRequest$Limit": "

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

", "ListAvailableManagedRuleGroupVersionsRequest$Limit": "

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

", "ListAvailableManagedRuleGroupsRequest$Limit": "

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

", "ListIPSetsRequest$Limit": "

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

", @@ -1630,7 +1699,7 @@ "RegexPatternSetSummaries": { "base": null, "refs": { - "ListRegexPatternSetsResponse$RegexPatternSets": "

" + "ListRegexPatternSetsResponse$RegexPatternSets": "

Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.

" } }, "RegexPatternSetSummary": { @@ -1664,7 +1733,7 @@ "ReleaseSummaries": { "base": null, "refs": { - "ListMobileSdkReleasesResponse$ReleaseSummaries": "

High level information for the available SDK releases.

" + "ListMobileSdkReleasesResponse$ReleaseSummaries": "

The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list.

" } }, "ReleaseSummary": { @@ -1897,7 +1966,7 @@ "RuleGroupSummaries": { "base": null, "refs": { - "ListRuleGroupsResponse$RuleGroups": "

" + "ListRuleGroupsResponse$RuleGroups": "

Array of rule groups. If you specified a Limit in your request, this might not be the full list.

" } }, "RuleGroupSummary": { @@ -1960,6 +2029,7 @@ "base": null, "refs": { "CheckCapacityRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", + "CreateAPIKeyRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "CreateIPSetRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "CreateRegexPatternSetRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "CreateRuleGroupRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", @@ -1969,6 +2039,7 @@ "DeleteRuleGroupRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "DeleteWebACLRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "DescribeManagedRuleGroupRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", + "GetDecryptedAPIKeyRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "GetIPSetRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "GetManagedRuleSetRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "GetRateBasedStatementManagedKeysRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", @@ -1976,6 +2047,7 @@ "GetRuleGroupRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "GetSampledRequestsRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "GetWebACLRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", + "ListAPIKeysRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "ListAvailableManagedRuleGroupVersionsRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "ListAvailableManagedRuleGroupsRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", "ListIPSetsRequest$Scope": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

", @@ -2099,7 +2171,7 @@ "TagInfoForResource": { "base": "

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

", "refs": { - "ListTagsForResourceResponse$TagInfoForResource": "

The collection of tagging definitions for the resource.

" + "ListTagsForResourceResponse$TagInfoForResource": "

The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list.

" } }, "TagKey": { @@ -2195,6 +2267,8 @@ "Timestamp": { "base": null, "refs": { + "APIKeySummary$CreationTimestamp": "

The date and time that the key was created.

", + "GetDecryptedAPIKeyResponse$CreationTimestamp": "

The date and time that the key was created.

", "ManagedRuleGroupVersion$LastUpdateTimestamp": "

The date and time that the managed rule group owner updated the rule group version information.

", "ManagedRuleSetVersion$PublishTimestamp": "

The time that you first published this version.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

", "ManagedRuleSetVersion$LastUpdateTimestamp": "

The last time that you updated this version.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

", @@ -2211,13 +2285,16 @@ "TokenDomain": { "base": null, "refs": { + "APIKeyTokenDomains$member": null, "TokenDomains$member": null } }, "TokenDomains": { "base": null, "refs": { + "APIKeySummary$TokenDomains": "

The token domains that are defined in this API key.

", "CreateWebACLRequest$TokenDomains": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

", + "GetDecryptedAPIKeyResponse$TokenDomains": "

The token domains that are defined in this API key.

", "UpdateWebACLRequest$TokenDomains": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

", "WebACL$TokenDomains": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

" } @@ -2455,7 +2532,7 @@ "WebACLSummaries": { "base": null, "refs": { - "ListWebACLsResponse$WebACLs": "

" + "ListWebACLsResponse$WebACLs": "

Array of web ACLs. If you specified a Limit in your request, this might not be the full list.

" } }, "WebACLSummary": { diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index be585fdf79..d1d5d7f065 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -7433,6 +7433,7 @@ "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ap-southeast-3" : { }, + "ap-southeast-4" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-central-2" : { }, @@ -9033,6 +9034,12 @@ "deprecated" : true, "hostname" : "kms-fips.eu-west-3.amazonaws.com" }, + "il-central-1-fips" : { + "credentialScope" : { + "region" : "il-central-1" + }, + "hostname" : "kms-fips.il-central-1.amazonaws.com" + }, "me-central-1" : { "variants" : [ { "hostname" : "kms-fips.me-central-1.amazonaws.com", diff --git a/service/chime/api.go b/service/chime/api.go index 4df3cfe409..05e3ee2d92 100644 --- a/service/chime/api.go +++ b/service/chime/api.go @@ -459,8 +459,8 @@ func (c *Chime) BatchCreateAttendeeRequest(input *BatchCreateAttendeeInput) (req // // Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For // more information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) in the +// Amazon Chime SDK Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1697,8 +1697,8 @@ func (c *Chime) CreateAttendeeRequest(input *CreateAttendeeInput) (req *request. // CreateAttendee API operation for Amazon Chime. // // Creates a new attendee for an active Amazon Chime SDK meeting. For more information -// about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2456,10 +2456,10 @@ func (c *Chime) CreateMeetingRequest(input *CreateMeetingInput) (req *request.Re // // Creates a new Amazon Chime SDK meeting in the specified media Region with // no initial attendees. For more information about specifying media Regions, -// see Amazon Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) -// in the Amazon Chime Developer Guide . For more information about the Amazon -// Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide . +// see Amazon Chime SDK Media Regions (https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html) +// in the Amazon Chime SDK Developer Guide . For more information about the +// Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2665,10 +2665,10 @@ func (c *Chime) CreateMeetingWithAttendeesRequest(input *CreateMeetingWithAttend // // Creates a new Amazon Chime SDK meeting in the specified media Region, with // attendees. For more information about specifying media Regions, see Amazon -// Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) -// in the Amazon Chime Developer Guide . For more information about the Amazon -// Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide . +// Chime SDK Media Regions (https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html) +// in the Amazon Chime SDK Developer Guide . For more information about the +// Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4307,8 +4307,8 @@ func (c *Chime) DeleteAttendeeRequest(input *DeleteAttendeeInput) (req *request. // Deletes an attendee from the specified Amazon Chime SDK meeting and deletes // their JoinToken. Attendees are automatically deleted when a Amazon Chime // SDK meeting is deleted. For more information about the Amazon Chime SDK, -// see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5109,8 +5109,8 @@ func (c *Chime) DeleteMeetingRequest(input *DeleteMeetingInput) (req *request.Re // Deletes the specified Amazon Chime SDK meeting. The operation deletes all // attendees, disconnects all clients, and prevents new clients from joining // the meeting. For more information about the Amazon Chime SDK, see Using the -// Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8296,8 +8296,8 @@ func (c *Chime) GetAttendeeRequest(input *GetAttendeeInput) (req *request.Reques // // Gets the Amazon Chime SDK attendee details for a specified meeting ID and // attendee ID. For more information about the Amazon Chime SDK, see Using the -// Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide . +// Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8886,8 +8886,8 @@ func (c *Chime) GetMeetingRequest(input *GetMeetingInput) (req *request.Request, // // Gets the Amazon Chime SDK meeting details for the specified meeting ID. For // more information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide . +// (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) in the +// Amazon Chime SDK Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11861,8 +11861,8 @@ func (c *Chime) ListAttendeesRequest(input *ListAttendeesInput) (req *request.Re // ListAttendees API operation for Amazon Chime. // // Lists the attendees for the specified Amazon Chime SDK meeting. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13526,8 +13526,8 @@ func (c *Chime) ListMeetingsRequest(input *ListMeetingsInput) (req *request.Requ // ListMeetings API operation for Amazon Chime. // // Lists up to 100 active Amazon Chime SDK meetings. For more information about -// the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) +// in the Amazon Chime SDK Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -17654,7 +17654,20 @@ func (c *Chime) StartMeetingTranscriptionRequest(input *StartMeetingTranscriptio // StartMeetingTranscription API operation for Amazon Chime. // -// Starts transcription for the specified meetingId. +// Starts transcription for the specified meetingId. For more information, refer +// to Using Amazon Chime SDK live transcription (https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html) +// in the Amazon Chime SDK Developer Guide. +// +// If you specify an invalid configuration, a TranscriptFailed event will be +// sent with the contents of the BadRequestException generated by Amazon Transcribe. +// For more information on each parameter and which combinations are valid, +// refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) +// API in the Amazon Transcribe Developer Guide. +// +// Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use +// of Amazon Transcribe is subject to the AWS Service Terms (https://aws.amazon.com/service-terms/), +// including the terms specific to the AWS Machine Learning and Artificial Intelligence +// Services. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -24287,7 +24300,7 @@ type ChimeSdkMeetingConfiguration struct { // The configuration for the artifacts in an Amazon Chime SDK meeting. ArtifactsConfiguration *ArtifactsConfiguration `type:"structure"` - // The source configuration for a specified media capture pipline. + // The source configuration for a specified media capture pipeline. SourceConfiguration *SourceConfiguration `type:"structure"` } @@ -25935,7 +25948,8 @@ type CreateMediaCapturePipelineInput struct { // be ChimeSdkMeeting. ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration `type:"structure"` - // The token assigned to the client making the pipeline request. + // The unique identifier for the client request. The token makes the API request + // idempotent. Use a different token for different media pipeline requests. // // ClientRequestToken is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateMediaCapturePipelineInput's @@ -31506,8 +31520,10 @@ func (s *EmergencyCallingConfiguration) SetDNIS(v []*DNISEmergencyCallingConfigu type EngineTranscribeMedicalSettings struct { _ struct{} `type:"structure"` - // Set this field to PHI to identify personal health information in the transcription - // output. + // Labels all personally identifiable information (PII) identified in your transcript. + // If you don't include PiiEntityTypes, all PII is identified. + // + // You can’t set ContentIdentificationType and ContentRedactionType. ContentIdentificationType *string `type:"string" enum:"TranscribeMedicalContentIdentificationType"` // The language code specified for the Amazon Transcribe Medical engine. @@ -31606,59 +31622,166 @@ func (s *EngineTranscribeMedicalSettings) SetVocabularyName(v string) *EngineTra return s } -// Settings specific to the Amazon Transcribe engine. +// Settings specific for Amazon Transcribe as the live transcription engine. +// +// If you specify an invalid combination of parameters, a TranscriptFailed event +// will be sent with the contents of the BadRequestException generated by Amazon +// Transcribe. For more information on each parameter and which combinations +// are valid, refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) +// API in the Amazon Transcribe Developer Guide. type EngineTranscribeSettings struct { _ struct{} `type:"structure"` - // Set this field to PII to identify personally identifiable information in - // the transcription output. + // Labels all personally identifiable information (PII) identified in your transcript. + // If you don't include PiiEntityTypes, all PII is identified. + // + // You can’t set ContentIdentificationType and ContentRedactionType. ContentIdentificationType *string `type:"string" enum:"TranscribeContentIdentificationType"` - // Set this field to PII to redact personally identifiable information in the - // transcription output. Content redaction is performed only upon complete transcription - // of the audio segments. + // Content redaction is performed at the segment level. If you don't include + // PiiEntityTypes, all PII is redacted. + // + // You can’t set ContentIdentificationType and ContentRedactionType. ContentRedactionType *string `type:"string" enum:"TranscribeContentRedactionType"` - // Generates partial transcription results that are less likely to change as - // meeting attendees speak. It does so by only allowing the last few words from - // the partial results to change. + // Enables partial result stabilization for your transcription. Partial result + // stabilization can reduce latency in your output, but may impact accuracy. EnablePartialResultsStabilization *bool `type:"boolean"` - // The language code specified for the Amazon Transcribe engine. + // Enables automatic language identification for your transcription. // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"TranscribeLanguageCode"` + // If you include IdentifyLanguage, you can optionally use LanguageOptions to + // include a list of language codes that you think may be present in your audio + // stream. Including language options can improve transcription accuracy. + // + // You can also use PreferredLanguage to include a preferred language. Doing + // so can help Amazon Transcribe identify the language faster. + // + // You must include either LanguageCode or IdentifyLanguage. + // + // Language identification can't be combined with custom language models or + // redaction. + IdentifyLanguage *bool `type:"boolean"` + + // Specify the language code that represents the language spoken. + // + // If you're unsure of the language spoken in your audio, consider using IdentifyLanguage + // to enable automatic language identification. + LanguageCode *string `type:"string" enum:"TranscribeLanguageCode"` - // The name of the language model used during transcription. + // Specify the name of the custom language model that you want to use when processing + // your transcription. Note that language model names are case sensitive. + // + // The language of the specified language model must match the language code. + // If the languages don't match, the custom language model isn't applied. There + // are no errors or warnings associated with a language mismatch. + // + // If you use Amazon Transcribe in multiple Regions, the custom language model + // must be available in Amazon Transcribe in each Region. LanguageModelName *string `min:"1" type:"string"` - // The stabity level of a partial results transcription. Determines how stable - // you want the transcription results to be. A higher level means the transcription - // results are less likely to change. + // Specify two or more language codes that represent the languages you think + // may be present in your media; including more than five is not recommended. + // If you're unsure what languages are present, do not include this parameter. + // + // Including language options can improve the accuracy of language identification. + // + // If you include LanguageOptions, you must also include IdentifyLanguage. + // + // You can only include one language dialect per language. For example, you + // cannot include en-US and en-AU. + LanguageOptions *string `min:"1" type:"string"` + + // Specify the level of stability to use when you enable partial results stabilization + // (EnablePartialResultsStabilization). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. PartialResultsStability *string `type:"string" enum:"TranscribePartialResultsStability"` - // Lists the PII entity types you want to identify or redact. To specify entity - // types, you must enable ContentIdentificationType or ContentRedactionType. + // Specify which types of personally identifiable information (PII) you want + // to redact in your transcript. You can include as many types as you'd like, + // or you can select ALL. + // + // Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, + // BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, + // EMAIL,NAME, PHONE, PIN, SSN, or ALL. // - // PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, - // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, - // PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. + // Note that if you include PiiEntityTypes, you must also include ContentIdentificationType + // or ContentRedactionType. // - // PiiEntityTypes is an optional parameter with a default value of ALL. + // If you include ContentRedactionType or ContentIdentificationType, but do + // not include PiiEntityTypes, all PII is redacted or identified. PiiEntityTypes *string `min:"1" type:"string"` - // The AWS Region passed to Amazon Transcribe. If you don't specify a Region, - // Amazon Chime uses the meeting's Region. + // Specify a preferred language from the subset of languages codes you specified + // in LanguageOptions. + // + // You can only use this parameter if you include IdentifyLanguage and LanguageOptions. + PreferredLanguage *string `type:"string" enum:"TranscribeLanguageCode"` + + // The AWS Region in which to use Amazon Transcribe. + // + // If you don't specify a Region, then the MediaRegion parameter of the CreateMeeting.html + // (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html) + // API will be used. However, if Amazon Transcribe is not available in the MediaRegion, + // then a TranscriptFailed event is sent. + // + // Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. + // For more information, refer to Choosing a transcription Region (https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region) + // in the Amazon Chime SDK Developer Guide. Region *string `type:"string" enum:"TranscribeRegion"` - // The filtering method passed to Amazon Transcribe. + // Specify how you want your vocabulary filter applied to your transcript. + // + // To replace words with ***, choose mask. + // + // To delete words, choose remove. + // + // To flag words without changing them, choose tag. VocabularyFilterMethod *string `type:"string" enum:"TranscribeVocabularyFilterMethod"` - // The name of the vocabulary filter passed to Amazon Transcribe. + // Specify the name of the custom vocabulary filter that you want to use when + // processing your transcription. Note that vocabulary filter names are case + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must + // be available in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more vocabulary filters + // with your transcription, use the VocabularyFilterNames parameter instead. VocabularyFilterName *string `type:"string"` - // The name of the vocabulary passed to Amazon Transcribe. + // Specify the names of the custom vocabulary filters that you want to use when + // processing your transcription. Note that vocabulary filter names are case + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must + // be available in Amazon Transcribe in each Region. + // + // If you're not including IdentifyLanguage and want to use a custom vocabulary + // filter with your transcription, use the VocabularyFilterName parameter instead. + VocabularyFilterNames *string `min:"1" type:"string"` + + // Specify the name of the custom vocabulary that you want to use when processing + // your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe multiple Regions, the vocabulary must be available + // in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more custom vocabularies + // with your transcription, use the VocabularyNames parameter instead. VocabularyName *string `type:"string"` + + // Specify the names of the custom vocabularies that you want to use when processing + // your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary must be + // available in Amazon Transcribe in each Region. + // + // If you don't include IdentifyLanguage and want to use a custom vocabulary + // with your transcription, use the VocabularyName parameter instead. + VocabularyNames *string `min:"1" type:"string"` } // String returns the string representation. @@ -31682,15 +31805,21 @@ func (s EngineTranscribeSettings) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *EngineTranscribeSettings) Validate() error { invalidParams := request.ErrInvalidParams{Context: "EngineTranscribeSettings"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } if s.LanguageModelName != nil && len(*s.LanguageModelName) < 1 { invalidParams.Add(request.NewErrParamMinLen("LanguageModelName", 1)) } + if s.LanguageOptions != nil && len(*s.LanguageOptions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LanguageOptions", 1)) + } if s.PiiEntityTypes != nil && len(*s.PiiEntityTypes) < 1 { invalidParams.Add(request.NewErrParamMinLen("PiiEntityTypes", 1)) } + if s.VocabularyFilterNames != nil && len(*s.VocabularyFilterNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VocabularyFilterNames", 1)) + } + if s.VocabularyNames != nil && len(*s.VocabularyNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VocabularyNames", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -31716,6 +31845,12 @@ func (s *EngineTranscribeSettings) SetEnablePartialResultsStabilization(v bool) return s } +// SetIdentifyLanguage sets the IdentifyLanguage field's value. +func (s *EngineTranscribeSettings) SetIdentifyLanguage(v bool) *EngineTranscribeSettings { + s.IdentifyLanguage = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *EngineTranscribeSettings) SetLanguageCode(v string) *EngineTranscribeSettings { s.LanguageCode = &v @@ -31728,6 +31863,12 @@ func (s *EngineTranscribeSettings) SetLanguageModelName(v string) *EngineTranscr return s } +// SetLanguageOptions sets the LanguageOptions field's value. +func (s *EngineTranscribeSettings) SetLanguageOptions(v string) *EngineTranscribeSettings { + s.LanguageOptions = &v + return s +} + // SetPartialResultsStability sets the PartialResultsStability field's value. func (s *EngineTranscribeSettings) SetPartialResultsStability(v string) *EngineTranscribeSettings { s.PartialResultsStability = &v @@ -31740,6 +31881,12 @@ func (s *EngineTranscribeSettings) SetPiiEntityTypes(v string) *EngineTranscribe return s } +// SetPreferredLanguage sets the PreferredLanguage field's value. +func (s *EngineTranscribeSettings) SetPreferredLanguage(v string) *EngineTranscribeSettings { + s.PreferredLanguage = &v + return s +} + // SetRegion sets the Region field's value. func (s *EngineTranscribeSettings) SetRegion(v string) *EngineTranscribeSettings { s.Region = &v @@ -31758,12 +31905,24 @@ func (s *EngineTranscribeSettings) SetVocabularyFilterName(v string) *EngineTran return s } +// SetVocabularyFilterNames sets the VocabularyFilterNames field's value. +func (s *EngineTranscribeSettings) SetVocabularyFilterNames(v string) *EngineTranscribeSettings { + s.VocabularyFilterNames = &v + return s +} + // SetVocabularyName sets the VocabularyName field's value. func (s *EngineTranscribeSettings) SetVocabularyName(v string) *EngineTranscribeSettings { s.VocabularyName = &v return s } +// SetVocabularyNames sets the VocabularyNames field's value. +func (s *EngineTranscribeSettings) SetVocabularyNames(v string) *EngineTranscribeSettings { + s.VocabularyNames = &v + return s +} + // The configuration that allows a bot to receive outgoing events. Can be either // an HTTPS endpoint or a Lambda function ARN. type EventsConfiguration struct { @@ -35850,7 +36009,7 @@ func (s *ListChannelMembershipsForAppInstanceUserInput) SetNextToken(v string) * type ListChannelMembershipsForAppInstanceUserOutput struct { _ struct{} `type:"structure"` - // The token passed by previous API calls until all requested users are returned. + // The information for the requested channel memberships. ChannelMemberships []*ChannelMembershipForAppInstanceUserSummary `type:"list"` // The token passed by previous API calls until all requested users are returned. @@ -38234,10 +38393,11 @@ func (s *ListVoiceConnectorsOutput) SetVoiceConnectors(v []*VoiceConnector) *Lis type LoggingConfiguration struct { _ struct{} `type:"structure"` - // Boolean that enables the logging of Voice Connector metrics to Cloudwatch. + // Boolean that enables logging of detailed media metrics for Voice Connectors + // to Amazon CloudWatch logs. EnableMediaMetricLogs *bool `type:"boolean"` - // When true, enables SIP message logs for sending to Amazon CloudWatch Logs. + // Boolean that enables SIP message logs to Amazon CloudWatch logs. EnableSIPLogs *bool `type:"boolean"` } @@ -40189,8 +40349,8 @@ func (s *PutEventsConfigurationInput) SetOutboundEventsHTTPSEndpoint(v string) * type PutEventsConfigurationOutput struct { _ struct{} `type:"structure"` - // The configuration that allows a bot to receive outgoing events. Can be either - // an HTTPS endpoint or a Lambda function ARN. + // The configuration that allows a bot to receive outgoing events. Can be an + // HTTPS endpoint or an AWS Lambda function ARN. EventsConfiguration *EventsConfiguration `type:"structure"` } @@ -40388,7 +40548,7 @@ func (s *PutSipMediaApplicationLoggingConfigurationInput) SetSipMediaApplication type PutSipMediaApplicationLoggingConfigurationOutput struct { _ struct{} `type:"structure"` - // Logging configuration of the SIP media application. + // The logging configuration of the SIP media application. SipMediaApplicationLoggingConfiguration *SipMediaApplicationLoggingConfiguration `type:"structure"` } @@ -41518,7 +41678,7 @@ type RegenerateSecurityTokenOutput struct { _ struct{} `type:"structure"` // A resource that allows Enterprise account administrators to configure an - // interface to receive events from Amazon Chime. + // interface that receives events from Amazon Chime. Bot *Bot `type:"structure"` } @@ -42717,8 +42877,8 @@ func (s *SipMediaApplicationCall) SetTransactionId(v string) *SipMediaApplicatio type SipMediaApplicationEndpoint struct { _ struct{} `type:"structure"` - // Valid Amazon Resource Name (ARN) of the Lambda function. The function must - // be created in the same AWS Region as the SIP media application. + // Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. + // The function must be created in the same AWS Region as the SIP media application. // // LambdaArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SipMediaApplicationEndpoint's @@ -48477,6 +48637,12 @@ const ( // TranscribeLanguageCodeZhCn is a TranscribeLanguageCode enum value TranscribeLanguageCodeZhCn = "zh-CN" + + // TranscribeLanguageCodeThTh is a TranscribeLanguageCode enum value + TranscribeLanguageCodeThTh = "th-TH" + + // TranscribeLanguageCodeHiIn is a TranscribeLanguageCode enum value + TranscribeLanguageCodeHiIn = "hi-IN" ) // TranscribeLanguageCode_Values returns all elements of the TranscribeLanguageCode enum @@ -48494,6 +48660,8 @@ func TranscribeLanguageCode_Values() []string { TranscribeLanguageCodeJaJp, TranscribeLanguageCodeKoKr, TranscribeLanguageCodeZhCn, + TranscribeLanguageCodeThTh, + TranscribeLanguageCodeHiIn, } } diff --git a/service/chime/doc.go b/service/chime/doc.go index 8e7627c513..0380c6cff1 100644 --- a/service/chime/doc.go +++ b/service/chime/doc.go @@ -3,19 +3,16 @@ // Package chime provides the client and types for making API // requests to Amazon Chime. // -// The Amazon Chime API (application programming interface) is designed for -// developers to perform key tasks, such as creating and managing Amazon Chime -// accounts, users, and Voice Connectors. This guide provides detailed information -// about the Amazon Chime API, including operations, types, inputs and outputs, -// and error codes. It also includes API actions for use with the Amazon Chime -// SDK, which developers use to build their own communication applications. -// For more information about the Amazon Chime SDK, see Using the Amazon Chime -// SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the -// Amazon Chime Developer Guide. +// The Amazon Chime application programming interface (API) is designed so administrators +// can perform key tasks, such as creating and managing Amazon Chime accounts, +// users, and Voice Connectors. This guide provides detailed information about +// the Amazon Chime API, including operations, types, inputs and outputs, and +// error codes. // // You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the -// REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. -// Each API operation includes links to information about using it with a language-specific +// REST API to make API calls for Amazon Chime. We recommend using an AWS SDK +// or the AWS CLI. The page for each API action contains a See Also section +// that includes links to information about using the action with a language-specific // AWS SDK or the AWS CLI. // // # Using an AWS SDK @@ -37,7 +34,7 @@ // # Using REST APIs // // If you use REST to make API calls, you must authenticate your request by -// providing a signature. Amazon Chime supports signature version 4. For more +// providing a signature. Amazon Chime supports Signature Version 4. For more // information, see Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) // in the Amazon Web Services General Reference. // diff --git a/service/chimesdkmediapipelines/api.go b/service/chimesdkmediapipelines/api.go index 45651501a1..805f1b5363 100644 --- a/service/chimesdkmediapipelines/api.go +++ b/service/chimesdkmediapipelines/api.go @@ -2058,9 +2058,8 @@ func (c *ChimeSDKMediaPipelines) UpdateMediaInsightsPipelineStatusWithContext(ct type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { _ struct{} `type:"structure"` - // By default, all CategoryEvents will be sent to the insights target. If this - // parameter is specified, only included categories will be sent to the insights - // target. + // By default, all CategoryEvents are sent to the insights target. If this parameter + // is specified, only included categories are sent to the insights target. CallAnalyticsStreamCategories []*string `min:"1" type:"list"` // Labels all personally identifiable information (PII) identified in your transcript. @@ -2398,7 +2397,8 @@ type AmazonTranscribeProcessorConfiguration struct { // BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, // EMAIL, NAME, PHONE, PIN, SSN, or ALL. // - // Length Constraints: Minimum length of 1. Maximum length of 300. + // If you leave this parameter empty, the default behavior is equivalent to + // ALL. PiiEntityTypes *string `min:"1" type:"string"` // Enables speaker partitioning (diarization) in your transcription output. @@ -5371,7 +5371,7 @@ func (s *KeywordMatchConfiguration) SetRuleName(v string) *KeywordMatchConfigura type KinesisDataStreamSinkConfiguration struct { _ struct{} `type:"structure"` - // The URL of the sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/). + // The ARN of the sink. // // InsightsTarget is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by KinesisDataStreamSinkConfiguration's @@ -5602,7 +5602,7 @@ func (s *KinesisVideoStreamSourceRuntimeConfiguration) SetStreams(v []*StreamCon type LambdaFunctionSinkConfiguration struct { _ struct{} `type:"structure"` - // The URL of the sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/). + // The ARN of the sink. // // InsightsTarget is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by LambdaFunctionSinkConfiguration's @@ -7280,7 +7280,16 @@ func (s *NotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// The settings for a post-call voice analytics task. +// Allows you to specify additional settings for your Call Analytics post-call +// request, including output locations for your redacted transcript, which IAM +// role to use, and which encryption key to use. +// +// DataAccessRoleArn and OutputLocation are required fields. +// +// PostCallAnalyticsSettings provides the same insights as a Call Analytics +// post-call transcription. For more information, refer to Post-call analytics +// with real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html) +// in the Amazon Transcribe Developer Guide. type PostCallAnalyticsSettings struct { _ struct{} `type:"structure"` @@ -7295,7 +7304,7 @@ type PostCallAnalyticsSettings struct { // DataAccessRoleArn is a required field DataAccessRoleArn *string `type:"string" required:"true"` - // The ID of the KMS (Key Management System) key used to encrypt the output. + // The ID of the KMS (Key Management Service) key used to encrypt the output. OutputEncryptionKMSKeyId *string `type:"string"` // The URL of the Amazon S3 bucket that contains the post-call data. @@ -7362,7 +7371,7 @@ func (s *PostCallAnalyticsSettings) SetOutputLocation(v string) *PostCallAnalyti return s } -// Defines the configuration for a presenter only video tile. +// Defines the configuration for a presenter-only video tile. type PresenterOnlyConfiguration struct { _ struct{} `type:"structure"` @@ -7548,7 +7557,7 @@ func (s *RealTimeAlertRule) SetType(v string) *RealTimeAlertRule { return s } -// A structure the holds the settings for recording audio and video. +// A structure that holds the settings for recording media. type RecordingStreamConfiguration struct { _ struct{} `type:"structure"` @@ -7716,17 +7725,21 @@ func (s *S3BucketSinkConfiguration) SetDestination(v string) *S3BucketSinkConfig return s } -// The structure that holds the settings for transmitting audio and video to -// the Amazon S3 bucket. +// The structure that holds the settings for transmitting media to the Amazon +// S3 bucket. These values are used as defaults if S3RecordingSinkRuntimeConfiguration +// is not specified. type S3RecordingSinkConfiguration struct { _ struct{} `type:"structure"` - // The URL of the Amazon S3 bucket used as the recording sink. + // The default URI of the Amazon S3 bucket used as the recording sink. // // Destination is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by S3RecordingSinkConfiguration's // String and GoString methods. Destination *string `min:"1" type:"string" sensitive:"true"` + + // The default file format for the media files sent to the Amazon S3 bucket. + RecordingFileFormat *string `type:"string" enum:"RecordingFileFormat"` } // String returns the string representation. @@ -7766,12 +7779,19 @@ func (s *S3RecordingSinkConfiguration) SetDestination(v string) *S3RecordingSink return s } -// A structure that holds the settings for transmitting audio and video recordings -// to the runtime Amazon S3 bucket. +// SetRecordingFileFormat sets the RecordingFileFormat field's value. +func (s *S3RecordingSinkConfiguration) SetRecordingFileFormat(v string) *S3RecordingSinkConfiguration { + s.RecordingFileFormat = &v + return s +} + +// A structure that holds the settings for transmitting media files to the Amazon +// S3 bucket. If specified, the settings in this structure override any settings +// in S3RecordingSinkConfiguration. type S3RecordingSinkRuntimeConfiguration struct { _ struct{} `type:"structure"` - // The URL of the S3 bucket used as the runtime sink. + // The URI of the S3 bucket used as the sink. // // Destination is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by S3RecordingSinkRuntimeConfiguration's @@ -7780,7 +7800,7 @@ type S3RecordingSinkRuntimeConfiguration struct { // Destination is a required field Destination *string `min:"1" type:"string" required:"true" sensitive:"true"` - // The file formats for the audio and video files sent to the Amazon S3 bucket. + // The file format for the media files sent to the Amazon S3 bucket. // // RecordingFileFormat is a required field RecordingFileFormat *string `type:"string" required:"true" enum:"RecordingFileFormat"` @@ -8117,7 +8137,7 @@ func (s *ServiceUnavailableException) RequestID() string { type SnsTopicSinkConfiguration struct { _ struct{} `type:"structure"` - // The URL of the SNS sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/). + // The ARN of the SNS sink. // // InsightsTarget is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnsTopicSinkConfiguration's @@ -8210,11 +8230,11 @@ func (s *SourceConfiguration) SetSelectedVideoStreams(v *SelectedVideoStreams) * return s } -// The URL of the SQS sink. +// The configuration settings for the SQS sink. type SqsQueueSinkConfiguration struct { _ struct{} `type:"structure"` - // The URL of the SQS sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/). + // The ARN of the SQS sink. // // InsightsTarget is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SqsQueueSinkConfiguration's diff --git a/service/chimesdkmeetings/api.go b/service/chimesdkmeetings/api.go index 200ddbd3a7..a932eed2d2 100644 --- a/service/chimesdkmeetings/api.go +++ b/service/chimesdkmeetings/api.go @@ -183,7 +183,7 @@ func (c *ChimeSDKMeetings) BatchUpdateAttendeeCapabilitiesExceptRequest(input *B // // - When you change a video or content capability from None or Receive to // Send or SendReceive , and if the attendee turned on their video or content -// streams, remote attendess can receive those streams, but only after media +// streams, remote attendees can receive those streams, but only after media // renegotiation between the client and the Amazon Chime back-end server. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1231,6 +1231,12 @@ func (c *ChimeSDKMeetings) StartMeetingTranscriptionRequest(input *StartMeetingT // to Using Amazon Chime SDK live transcription (https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html) // in the Amazon Chime SDK Developer Guide. // +// If you specify an invalid configuration, a TranscriptFailed event will be +// sent with the contents of the BadRequestException generated by Amazon Transcribe. +// For more information on each parameter and which combinations are valid, +// refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) +// API in the Amazon Transcribe Developer Guide. +// // Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use // of Amazon Transcribe is subject to the AWS Service Terms (https://aws.amazon.com/service-terms/), // including the terms specific to the AWS Machine Learning and Artificial Intelligence @@ -1639,7 +1645,7 @@ func (c *ChimeSDKMeetings) UpdateAttendeeCapabilitiesRequest(input *UpdateAttend // UpdateAttendeeCapabilities API operation for Amazon Chime SDK Meetings. // -// The capabilties that you want to update. +// The capabilities that you want to update. // // You use the capabilities with a set of values that control what the capabilities // can do, such as SendReceive data. For more information about those values, @@ -1659,7 +1665,7 @@ func (c *ChimeSDKMeetings) UpdateAttendeeCapabilitiesRequest(input *UpdateAttend // // - When you change a video or content capability from None or Receive to // Send or SendReceive , and if the attendee turned on their video or content -// streams, remote attendess can receive those streams, but only after media +// streams, remote attendees can receive those streams, but only after media // renegotiation between the client and the Amazon Chime back-end server. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1745,7 +1751,7 @@ type Attendee struct { // // * When you change a video or content capability from None or Receive to // Send or SendReceive , and if the attendee turned on their video or content - // streams, remote attendess can receive those streams, but only after media + // streams, remote attendees can receive those streams, but only after media // renegotiation between the client and the Amazon Chime back-end server. Capabilities *AttendeeCapabilities `type:"structure"` @@ -1832,7 +1838,7 @@ func (s *Attendee) SetJoinToken(v string) *Attendee { // // - When you change a video or content capability from None or Receive to // Send or SendReceive , and if the attendee turned on their video or content -// streams, remote attendess can receive those streams, but only after media +// streams, remote attendees can receive those streams, but only after media // renegotiation between the client and the Amazon Chime back-end server. type AttendeeCapabilities struct { _ struct{} `type:"structure"` @@ -2447,7 +2453,7 @@ type CreateAttendeeInput struct { // // * When you change a video or content capability from None or Receive to // Send or SendReceive , and if the attendee turned on their video or content - // streams, remote attendess can receive those streams, but only after media + // streams, remote attendees can receive those streams, but only after media // renegotiation between the client and the Amazon Chime back-end server. Capabilities *AttendeeCapabilities `type:"structure"` @@ -3419,70 +3425,165 @@ func (s *EngineTranscribeMedicalSettings) SetVocabularyName(v string) *EngineTra return s } -// Settings specific to the Amazon Transcribe engine. +// Settings specific for Amazon Transcribe as the live transcription engine. +// +// If you specify an invalid combination of parameters, a TranscriptFailed event +// will be sent with the contents of the BadRequestException generated by Amazon +// Transcribe. For more information on each parameter and which combinations +// are valid, refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) +// API in the Amazon Transcribe Developer Guide. type EngineTranscribeSettings struct { _ struct{} `type:"structure"` - // Set this field to PII to identify personally identifiable information in - // the transcription output. + // Labels all personally identifiable information (PII) identified in your transcript. + // If you don't include PiiEntityTypes, all PII is identified. + // + // You can’t set ContentIdentificationType and ContentRedactionType. ContentIdentificationType *string `type:"string" enum:"TranscribeContentIdentificationType"` - // Set this field to PII to redact personally identifiable information in the - // transcription output. Content redaction is performed only upon complete transcription - // of the audio segments. + // Content redaction is performed at the segment level. If you don't include + // PiiEntityTypes, all PII is redacted. // - // You can’t set ContentRedactionType and ContentIdentificationType in the - // same request. If you set both, your request returns a BadRequestException. + // You can’t set ContentRedactionType and ContentIdentificationType. ContentRedactionType *string `type:"string" enum:"TranscribeContentRedactionType"` - // Generates partial transcription results that are less likely to change as - // meeting attendees speak. It does so by only allowing the last few words from - // the partial results to change. + // Enables partial result stabilization for your transcription. Partial result + // stabilization can reduce latency in your output, but may impact accuracy. EnablePartialResultsStabilization *bool `type:"boolean"` - // Automatically identifies the language spoken in media files. + // Enables automatic language identification for your transcription. + // + // If you include IdentifyLanguage, you can optionally use LanguageOptions to + // include a list of language codes that you think may be present in your audio + // stream. Including language options can improve transcription accuracy. + // + // You can also use PreferredLanguage to include a preferred language. Doing + // so can help Amazon Transcribe identify the language faster. + // + // You must include either LanguageCode or IdentifyLanguage. + // + // Language identification can't be combined with custom language models or + // redaction. IdentifyLanguage *bool `type:"boolean"` - // The language code specified for the Amazon Transcribe engine. + // Specify the language code that represents the language spoken. + // + // If you're unsure of the language spoken in your audio, consider using IdentifyLanguage + // to enable automatic language identification. LanguageCode *string `type:"string" enum:"TranscribeLanguageCode"` - // The name of the language model used during transcription. + // Specify the name of the custom language model that you want to use when processing + // your transcription. Note that language model names are case sensitive. + // + // The language of the specified language model must match the language code. + // If the languages don't match, the custom language model isn't applied. There + // are no errors or warnings associated with a language mismatch. + // + // If you use Amazon Transcribe in multiple Regions, the custom language model + // must be available in Amazon Transcribe in each Region. LanguageModelName *string `min:"1" type:"string"` - // Language codes for the languages that you want to identify. You must provide - // at least 2 codes. + // Specify two or more language codes that represent the languages you think + // may be present in your media; including more than five is not recommended. + // If you're unsure what languages are present, do not include this parameter. + // + // Including language options can improve the accuracy of language identification. + // + // If you include LanguageOptions, you must also include IdentifyLanguage. + // + // You can only include one language dialect per language. For example, you + // cannot include en-US and en-AU. LanguageOptions *string `min:"1" type:"string"` - // The stabity level of a partial results transcription. Determines how stable - // you want the transcription results to be. A higher level means the transcription - // results are less likely to change. + // Specify the level of stability to use when you enable partial results stabilization + // (EnablePartialResultsStabilization). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. PartialResultsStability *string `type:"string" enum:"TranscribePartialResultsStability"` - // Lists the PII entity types you want to identify or redact. To specify entity - // types, you must enable ContentIdentificationType or ContentRedactionType. + // Specify which types of personally identifiable information (PII) you want + // to redact in your transcript. You can include as many types as you'd like, + // or you can select ALL. // - // PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, - // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, - // PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. + // Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, + // BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, + // EMAIL,NAME, PHONE, PIN, SSN, or ALL. // - // PiiEntityTypes is an optional parameter with a default value of ALL. + // Note that if you include PiiEntityTypes, you must also include ContentIdentificationType + // or ContentRedactionType. + // + // If you include ContentRedactionType or ContentIdentificationType, but do + // not include PiiEntityTypes, all PII is redacted or identified. PiiEntityTypes *string `min:"1" type:"string"` - // Language code for the preferred language. + // Specify a preferred language from the subset of languages codes you specified + // in LanguageOptions. + // + // You can only use this parameter if you include IdentifyLanguage and LanguageOptions. PreferredLanguage *string `type:"string" enum:"TranscribeLanguageCode"` - // The AWS Region passed to Amazon Transcribe. If you don't specify a Region, - // Amazon Chime uses the meeting's Region. + // The AWS Region in which to use Amazon Transcribe. + // + // If you don't specify a Region, then the MediaRegion (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html) + // of the meeting is used. However, if Amazon Transcribe is not available in + // the MediaRegion, then a TranscriptFailed event is sent. + // + // Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. + // For more information, refer to Choosing a transcription Region (https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region) + // in the Amazon Chime SDK Developer Guide. Region *string `type:"string" enum:"TranscribeRegion"` - // The filtering method passed to Amazon Transcribe. + // Specify how you want your vocabulary filter applied to your transcript. + // + // To replace words with ***, choose mask. + // + // To delete words, choose remove. + // + // To flag words without changing them, choose tag. VocabularyFilterMethod *string `type:"string" enum:"TranscribeVocabularyFilterMethod"` - // The name of the vocabulary filter passed to Amazon Transcribe. + // Specify the name of the custom vocabulary filter that you want to use when + // processing your transcription. Note that vocabulary filter names are case + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must + // be available in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more vocabulary filters + // with your transcription, use the VocabularyFilterNames parameter instead. VocabularyFilterName *string `type:"string"` - // The name of the vocabulary passed to Amazon Transcribe. + // Specify the names of the custom vocabulary filters that you want to use when + // processing your transcription. Note that vocabulary filter names are case + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must + // be available in Amazon Transcribe in each Region. + // + // If you're not including IdentifyLanguage and want to use a custom vocabulary + // filter with your transcription, use the VocabularyFilterName parameter instead. + VocabularyFilterNames *string `min:"1" type:"string"` + + // Specify the name of the custom vocabulary that you want to use when processing + // your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe multiple Regions, the vocabulary must be available + // in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more custom vocabularies + // with your transcription, use the VocabularyNames parameter instead. VocabularyName *string `type:"string"` + + // Specify the names of the custom vocabularies that you want to use when processing + // your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary must be + // available in Amazon Transcribe in each Region. + // + // If you don't include IdentifyLanguage and want to use a custom vocabulary + // with your transcription, use the VocabularyName parameter instead. + VocabularyNames *string `min:"1" type:"string"` } // String returns the string representation. @@ -3515,6 +3616,12 @@ func (s *EngineTranscribeSettings) Validate() error { if s.PiiEntityTypes != nil && len(*s.PiiEntityTypes) < 1 { invalidParams.Add(request.NewErrParamMinLen("PiiEntityTypes", 1)) } + if s.VocabularyFilterNames != nil && len(*s.VocabularyFilterNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VocabularyFilterNames", 1)) + } + if s.VocabularyNames != nil && len(*s.VocabularyNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VocabularyNames", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -3600,12 +3707,24 @@ func (s *EngineTranscribeSettings) SetVocabularyFilterName(v string) *EngineTran return s } +// SetVocabularyFilterNames sets the VocabularyFilterNames field's value. +func (s *EngineTranscribeSettings) SetVocabularyFilterNames(v string) *EngineTranscribeSettings { + s.VocabularyFilterNames = &v + return s +} + // SetVocabularyName sets the VocabularyName field's value. func (s *EngineTranscribeSettings) SetVocabularyName(v string) *EngineTranscribeSettings { s.VocabularyName = &v return s } +// SetVocabularyNames sets the VocabularyNames field's value. +func (s *EngineTranscribeSettings) SetVocabularyNames(v string) *EngineTranscribeSettings { + s.VocabularyNames = &v + return s +} + // The client is permanently forbidden from making the request. type ForbiddenException struct { _ struct{} `type:"structure"` @@ -5481,7 +5600,7 @@ type UpdateAttendeeCapabilitiesInput struct { // AttendeeId is a required field AttendeeId *string `location:"uri" locationName:"AttendeeId" type:"string" required:"true"` - // The capabilties that you want to update. + // The capabilities that you want to update. // // Capabilities is a required field Capabilities *AttendeeCapabilities `type:"structure" required:"true"` @@ -5689,6 +5808,12 @@ const ( // TranscribeLanguageCodeZhCn is a TranscribeLanguageCode enum value TranscribeLanguageCodeZhCn = "zh-CN" + + // TranscribeLanguageCodeThTh is a TranscribeLanguageCode enum value + TranscribeLanguageCodeThTh = "th-TH" + + // TranscribeLanguageCodeHiIn is a TranscribeLanguageCode enum value + TranscribeLanguageCodeHiIn = "hi-IN" ) // TranscribeLanguageCode_Values returns all elements of the TranscribeLanguageCode enum @@ -5706,6 +5831,8 @@ func TranscribeLanguageCode_Values() []string { TranscribeLanguageCodeJaJp, TranscribeLanguageCodeKoKr, TranscribeLanguageCodeZhCn, + TranscribeLanguageCodeThTh, + TranscribeLanguageCodeHiIn, } } diff --git a/service/gamelift/api.go b/service/gamelift/api.go index 6b1989795e..2818df14c7 100644 --- a/service/gamelift/api.go +++ b/service/gamelift/api.go @@ -177,20 +177,20 @@ func (c *GameLift) ClaimGameServerRequest(input *ClaimGameServerInput) (req *req // ClaimGameServer API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Locates an available game server and temporarily reserves it to host gameplay // and players. This operation is called from a game client or client service // (such as a matchmaker) to request hosting resources for a new game session. -// In response, GameLift FleetIQ locates an available game server, places it -// in CLAIMED status for 60 seconds, and returns connection information that +// In response, Amazon GameLift FleetIQ locates an available game server, places +// it in CLAIMED status for 60 seconds, and returns connection information that // players can use to connect to the game server. // // To claim a game server, identify a game server group. You can also specify -// a game server ID, although this approach bypasses GameLift FleetIQ placement -// optimization. Optionally, include game data to pass to the game server at -// the start of a game session, such as a game map or player information. +// a game server ID, although this approach bypasses Amazon GameLift FleetIQ +// placement optimization. Optionally, include game data to pass to the game +// server at the start of a game session, such as a game map or player information. // // When a game server is successfully claimed, connection information is returned. // A claimed game server's utilization status remains AVAILABLE while the claim @@ -213,7 +213,7 @@ func (c *GameLift) ClaimGameServerRequest(input *ClaimGameServerInput) (req *req // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -440,11 +440,11 @@ func (c *GameLift) CreateBuildRequest(input *CreateBuildInput) (req *request.Req // Creates a new Amazon GameLift build resource for your game server binary // files. Combine game server binaries into a zip file for use with Amazon GameLift. // -// When setting up a new game build for GameLift, we recommend using the CLI -// command upload-build (https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) +// When setting up a new game build for Amazon GameLift, we recommend using +// the CLI command upload-build (https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) // . This helper command combines two tasks: (1) it uploads your build files -// from a file directory to a GameLift Amazon S3 location, and (2) it creates -// a new build resource. +// from a file directory to a Amazon GameLift Amazon S3 location, and (2) it +// creates a new build resource. // // You can use the operation in the following scenarios: // @@ -454,14 +454,14 @@ func (c *GameLift) CreateBuildRequest(input *CreateBuildInput) (req *request.Req // With permissions in place, specify a build name, operating system, and // the Amazon S3 storage location of your game build. // -// - To directly upload your build files to a GameLift Amazon S3 location. +// - To directly upload your build files to a Amazon GameLift Amazon S3 location. // To use this option, specify a build name and operating system. This operation // creates a new build resource and also returns an Amazon S3 location with // temporary access credentials. Use the credentials to manually upload your // build files to the specified Amazon S3 location. For more information, // see Uploading Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html) // in the Amazon S3 Developer Guide. After you upload build files to the -// GameLift Amazon S3 location, you can't update them. +// Amazon GameLift Amazon S3 location, you can't update them. // // If successful, this operation creates a new build resource with a unique // build ID and places it in INITIALIZED status. A build must be in READY status @@ -571,25 +571,25 @@ func (c *GameLift) CreateFleetRequest(input *CreateFleetInput) (req *request.Req // CreateFleet API operation for Amazon GameLift. // -// Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) -// instances to host your custom game server or Realtime Servers. Use this operation -// to configure the computing resources for your fleet and provide instructions -// for running game servers on each instance. +// Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to +// host your custom game server or Realtime Servers. Use this operation to configure +// the computing resources for your fleet and provide instructions for running +// game servers on each instance. // -// Most GameLift fleets can deploy instances to multiple locations, including +// Most Amazon GameLift fleets can deploy instances to multiple locations, including // the home Region (where the fleet is created) and an optional set of remote // locations. Fleets that are created in the following Amazon Web Services Regions // support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), // eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 -// (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift -// Regions can deploy instances in the fleet's home Region only. All fleet instances -// use the same configuration regardless of location; however, you can adjust -// capacity settings and turn auto-scaling on/off for each location. +// (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other Amazon +// GameLift Regions can deploy instances in the fleet's home Region only. All +// fleet instances use the same configuration regardless of location; however, +// you can adjust capacity settings and turn auto-scaling on/off for each location. // // To create a fleet, choose the hardware for your instances, specify a game // server build or Realtime script to deploy, and provide a runtime configuration -// to direct GameLift how to start and run game servers on each instance in -// the fleet. Set permissions for inbound traffic to your game servers, and +// to direct Amazon GameLift how to start and run game servers on each instance +// in the fleet. Set permissions for inbound traffic to your game servers, and // enable optional features as needed. When creating a multi-location fleet, // provide a list of additional remote locations. // @@ -599,8 +599,8 @@ func (c *GameLift) CreateFleetRequest(input *CreateFleetInput) (req *request.Req // when you need them and closing them when you're finished. // // If successful, this operation creates a new Fleet resource and places it -// in NEW status, which prompts GameLift to initiate the fleet creation workflow -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html). +// in NEW status, which prompts Amazon GameLift to initiate the fleet creation +// workflow (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow). // // # Learn more // @@ -730,7 +730,7 @@ func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) // of one or more locations. // // If successful, this operation returns the list of added locations with their -// status set to NEW. GameLift initiates the process of starting an instance +// status set to NEW. Amazon GameLift initiates the process of starting an instance // in each added location. You can track the status of each new location by // monitoring location creation events using DescribeFleetEvents (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html). // @@ -778,6 +778,10 @@ func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) // a service resource associated with the request. Resolve the conflict before // retrying this request. // +// - LimitExceededException +// The requested operation would cause the resource to exceed the allowed service +// limit. Resolve the issue before retrying. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetLocations func (c *GameLift) CreateFleetLocations(input *CreateFleetLocationsInput) (*CreateFleetLocationsOutput, error) { req, out := c.CreateFleetLocationsRequest(input) @@ -843,15 +847,16 @@ func (c *GameLift) CreateGameServerGroupRequest(input *CreateGameServerGroupInpu // CreateGameServerGroup API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // -// Creates a GameLift FleetIQ game server group for managing game hosting on -// a collection of Amazon Elastic Compute Cloud instances for game hosting. +// Creates a Amazon GameLift FleetIQ game server group for managing game hosting +// on a collection of Amazon Elastic Compute Cloud instances for game hosting. // This operation creates the game server group, creates an Auto Scaling group // in your Amazon Web Services account, and establishes a link between the two -// groups. You can view the status of your game server groups in the GameLift -// console. Game server group metrics and events are emitted to Amazon CloudWatch. +// groups. You can view the status of your game server groups in the Amazon +// GameLift console. Game server group metrics and events are emitted to Amazon +// CloudWatch. // // Before creating a new game server group, you must have the following: // @@ -862,28 +867,28 @@ func (c *GameLift) CreateGameServerGroupRequest(input *CreateGameServerGroupInpu // in the Amazon Elastic Compute Cloud User Guide. // // - An IAM role that extends limited access to your Amazon Web Services -// account to allow GameLift FleetIQ to create and interact with the Auto -// Scaling group. For more information, see Create IAM roles for cross-service +// account to allow Amazon GameLift FleetIQ to create and interact with the +// Auto Scaling group. For more information, see Create IAM roles for cross-service // interaction (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) -// in the GameLift FleetIQ Developer Guide. +// in the Amazon GameLift FleetIQ Developer Guide. // // To create a new game server group, specify a unique group name, IAM role // and Amazon Elastic Compute Cloud launch template, and provide a list of instance // types that can be used in the group. You must also set initial maximum and // minimum limits on the group's instance count. You can optionally set an Auto -// Scaling policy with target tracking based on a GameLift FleetIQ metric. +// Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric. // // Once the game server group and corresponding Auto Scaling group are created, // you have full access to change the Auto Scaling group's configuration as // needed. Several properties that are set when creating a game server group, // including maximum/minimum size and auto-scaling policy settings, must be // updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling -// group properties are periodically updated by GameLift FleetIQ as part of -// its balancing activities to optimize for availability and cost. +// group properties are periodically updated by Amazon GameLift FleetIQ as part +// of its balancing activities to optimize for availability and cost. // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -983,7 +988,7 @@ func (c *GameLift) CreateGameSessionRequest(input *CreateGameSessionInput) (req // Creates a multiplayer game session for players in a specific fleet location. // This operation prompts an available server process to start a game session // and retrieves connection information for the new game session. As an alternative, -// consider using the GameLift game session placement feature with StartGameSessionPlacement +// consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) // , which uses FleetIQ algorithms and queues to optimize the placement process. // @@ -1147,10 +1152,10 @@ func (c *GameLift) CreateGameSessionQueueRequest(input *CreateGameSessionQueueIn // and find an available game server there, then prompts the game server process // to start a new game session. // -// A game session queue is configured with a set of destinations (GameLift fleets -// or aliases), which determine the locations where the queue can place new -// game sessions. These destinations can span multiple fleet types (Spot and -// On-Demand), instance types, and Amazon Web Services Regions. If the queue +// A game session queue is configured with a set of destinations (Amazon GameLift +// fleets or aliases), which determine the locations where the queue can place +// new game sessions. These destinations can span multiple fleet types (Spot +// and On-Demand), instance types, and Amazon Web Services Regions. If the queue // includes multi-location fleets, the queue is able to place game sessions // in all of a fleet's remote locations. You can opt to filter out individual // locations if needed. @@ -1390,20 +1395,21 @@ func (c *GameLift) CreateMatchmakingConfigurationRequest(input *CreateMatchmakin // CreateMatchmakingConfiguration API operation for Amazon GameLift. // // Defines a new matchmaking configuration for use with FlexMatch. Whether your -// are using FlexMatch with GameLift hosting or as a standalone matchmaking +// are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking // service, the matchmaking configuration sets out rules for matching players -// and forming teams. If you're also using GameLift hosting, it defines how -// to start game sessions for each match. Your matchmaking system can use multiple -// configurations to handle different game scenarios. All matchmaking requests -// identify the matchmaking configuration to use and provide player attributes -// consistent with that configuration. +// and forming teams. If you're also using Amazon GameLift hosting, it defines +// how to start game sessions for each match. Your matchmaking system can use +// multiple configurations to handle different game scenarios. All matchmaking +// requests identify the matchmaking configuration to use and provide player +// attributes consistent with that configuration. // // To create a matchmaking configuration, you must provide the following: configuration -// name and FlexMatch mode (with or without GameLift hosting); a rule set that -// specifies how to evaluate players and find acceptable matches; whether player -// acceptance is required; and the maximum time allowed for a matchmaking attempt. -// When using FlexMatch with GameLift hosting, you also need to identify the -// game session queue to use when starting a game session for the match. +// name and FlexMatch mode (with or without Amazon GameLift hosting); a rule +// set that specifies how to evaluate players and find acceptable matches; whether +// player acceptance is required; and the maximum time allowed for a matchmaking +// attempt. When using FlexMatch with Amazon GameLift hosting, you also need +// to identify the game session queue to use when starting a game session for +// the match. // // In addition, you must set up an Amazon Simple Notification Service topic // to receive matchmaking notifications. Provide the topic ARN in the matchmaking @@ -1642,7 +1648,7 @@ func (c *GameLift) CreatePlayerSessionRequest(input *CreatePlayerSessionInput) ( // a new PlayerSessions object is returned with a player session ID. The player // references the player session ID when sending a connection request to the // game session, and the game server can use it to validate the player reservation -// with the GameLift service. Player sessions cannot be updated. +// with the Amazon GameLift service. Player sessions cannot be updated. // // The maximum number of players per game session is 200. It is not adjustable. // @@ -1768,7 +1774,7 @@ func (c *GameLift) CreatePlayerSessionsRequest(input *CreatePlayerSessionsInput) // new PlayerSession objects are returned with player session IDs. Each player // references their player session ID when sending a connection request to the // game session, and the game server can use it to validate the player reservation -// with the GameLift service. Player sessions cannot be updated. +// with the Amazon GameLift service. Player sessions cannot be updated. // // The maximum number of players per game session is 200. It is not adjustable. // @@ -2486,7 +2492,7 @@ func (c *GameLift) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Req // // # Learn more // -// Setting up GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2601,7 +2607,7 @@ func (c *GameLift) DeleteFleetLocationsRequest(input *DeleteFleetLocationsInput) // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2696,8 +2702,8 @@ func (c *GameLift) DeleteGameServerGroupRequest(input *DeleteGameServerGroupInpu // DeleteGameServerGroup API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Terminates a game server group and permanently deletes the game server group // record. You have several options for how these resources are impacted when @@ -2717,15 +2723,15 @@ func (c *GameLift) DeleteGameServerGroupRequest(input *DeleteGameServerGroupInpu // If the delete request is successful, a series of operations are kicked off. // The game server group status is changed to DELETE_SCHEDULED, which prevents // new game servers from being registered and stops automatic scaling activity. -// Once all game servers in the game server group are deregistered, GameLift +// Once all game servers in the game server group are deregistered, Amazon GameLift // FleetIQ can begin deleting resources. If any of the delete operations fail, // the game server group is placed in ERROR status. // -// GameLift FleetIQ emits delete events to Amazon CloudWatch. +// Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch. // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3221,7 +3227,7 @@ func (c *GameLift) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) ( // DeleteScalingPolicy API operation for Amazon GameLift. // // Deletes a fleet scaling policy. Once deleted, the policy is no longer in -// force and GameLift removes all record of it. To delete a scaling policy, +// force and Amazon GameLift removes all record of it. To delete a scaling policy, // specify both the scaling policy name and the fleet ID it is associated with. // // To temporarily suspend scaling policies, use StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html). @@ -3728,8 +3734,8 @@ func (c *GameLift) DeregisterGameServerRequest(input *DeregisterGameServerInput) // DeregisterGameServer API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Removes the game server from a game server group. As a result of this operation, // the deregistered game server can no longer be claimed and will not be returned @@ -3741,7 +3747,7 @@ func (c *GameLift) DeregisterGameServerRequest(input *DeregisterGameServerInput) // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4034,8 +4040,8 @@ func (c *GameLift) DescribeComputeRequest(input *DescribeComputeInput) (req *req // DescribeCompute API operation for Amazon GameLift. // // Retrieves properties for a compute resource. To request a compute resource -// specify the fleet ID and compute name. If successful, GameLift returns an -// object containing the build properties. +// specify the fleet ID and compute name. If successful, Amazon GameLift returns +// an object containing the build properties. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4133,9 +4139,9 @@ func (c *GameLift) DescribeEC2InstanceLimitsRequest(input *DescribeEC2InstanceLi // Learn more at Amazon EC2 Instance Types (http://aws.amazon.com/ec2/instance-types/). // The information returned includes the maximum number of instances allowed // and your account's current usage across all fleets. This information can -// affect your ability to scale your GameLift fleets. You can request a limit -// increase for your account by using the Service limits page in the GameLift -// console. +// affect your ability to scale your Amazon GameLift fleets. You can request +// a limit increase for your account by using the Service limits page in the +// Amazon GameLift console. // // Instance limits differ based on whether the instances are deployed in a fleet's // home Region or in a remote location. For remote locations, limits also differ @@ -4176,7 +4182,7 @@ func (c *GameLift) DescribeEC2InstanceLimitsRequest(input *DescribeEC2InstanceLi // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4295,7 +4301,7 @@ func (c *GameLift) DescribeFleetAttributesRequest(input *DescribeFleetAttributes // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4470,7 +4476,7 @@ func (c *GameLift) DescribeFleetCapacityRequest(input *DescribeFleetCapacityInpu // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // @@ -4634,7 +4640,7 @@ func (c *GameLift) DescribeFleetEventsRequest(input *DescribeFleetEventsInput) ( // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4804,7 +4810,7 @@ func (c *GameLift) DescribeFleetLocationAttributesRequest(input *DescribeFleetLo // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4963,7 +4969,7 @@ func (c *GameLift) DescribeFleetLocationCapacityRequest(input *DescribeFleetLoca // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // @@ -5073,7 +5079,7 @@ func (c *GameLift) DescribeFleetLocationUtilizationRequest(input *DescribeFleetL // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // @@ -5190,7 +5196,7 @@ func (c *GameLift) DescribeFleetPortSettingsRequest(input *DescribeFleetPortSett // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5318,7 +5324,7 @@ func (c *GameLift) DescribeFleetUtilizationRequest(input *DescribeFleetUtilizati // // # Learn more // -// Setting up GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // GameLift Metrics for Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // @@ -5463,8 +5469,8 @@ func (c *GameLift) DescribeGameServerRequest(input *DescribeGameServerInput) (re // DescribeGameServer API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Retrieves information for a registered game server. Information includes // game server status, health check info, and the instance that the game server @@ -5475,7 +5481,7 @@ func (c *GameLift) DescribeGameServerRequest(input *DescribeGameServerInput) (re // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5567,12 +5573,12 @@ func (c *GameLift) DescribeGameServerGroupRequest(input *DescribeGameServerGroup // DescribeGameServerGroup API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Retrieves information on a game server group. This operation returns only -// properties related to GameLift FleetIQ. To view or update properties for -// the corresponding Auto Scaling group, such as launch template, auto scaling +// properties related to Amazon GameLift FleetIQ. To view or update properties +// for the corresponding Auto Scaling group, such as launch template, auto scaling // policies, and maximum/minimum group size, access the Auto Scaling group directly. // // To get attributes for a game server group, provide a group name or ARN value. @@ -5580,7 +5586,7 @@ func (c *GameLift) DescribeGameServerGroupRequest(input *DescribeGameServerGroup // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5678,12 +5684,12 @@ func (c *GameLift) DescribeGameServerInstancesRequest(input *DescribeGameServerI // DescribeGameServerInstances API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Retrieves status information about the Amazon EC2 instances associated with -// a GameLift FleetIQ game server group. Use this operation to detect when instances -// are active or not available to host new game servers. +// a Amazon GameLift FleetIQ game server group. Use this operation to detect +// when instances are active or not available to host new game servers. // // To request status for all instances in the game server group, provide a game // server group ID only. To request status for specific instances, provide the @@ -5698,7 +5704,7 @@ func (c *GameLift) DescribeGameServerInstancesRequest(input *DescribeGameServerI // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7260,8 +7266,8 @@ func (c *GameLift) DescribeRuntimeConfigurationRequest(input *DescribeRuntimeCon // DescribeRuntimeConfiguration API operation for Amazon GameLift. // // Retrieves a fleet's runtime configuration settings. The runtime configuration -// tells GameLift which server processes to run (and how) on each instance in -// the fleet. +// tells Amazon GameLift which server processes to run (and how) on each instance +// in the fleet. // // To get the runtime configuration that is currently in forces for a fleet, // provide the fleet ID. @@ -7271,7 +7277,7 @@ func (c *GameLift) DescribeRuntimeConfigurationRequest(input *DescribeRuntimeCon // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Running multiple processes on a fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) // @@ -7831,13 +7837,13 @@ func (c *GameLift) GetComputeAccessRequest(input *GetComputeAccessInput) (req *r // gathering benchmarking data, or observing activity in real time. // // To remotely access an instance, you need credentials that match the operating -// system of the instance. For a Windows instance, GameLift returns a user name -// and password as strings for use with a Windows Remote Desktop client. For -// a Linux instance, GameLift returns a user name and RSA private key, also -// as strings, for use with an SSH client. The private key must be saved in -// the proper format to a .pem file before using. If you're making this request -// using the CLI, saving the secret can be handled as part of the GetInstanceAccess -// request, as shown in one of the examples for this operation. +// system of the instance. For a Windows instance, Amazon GameLift returns a +// user name and password as strings for use with a Windows Remote Desktop client. +// For a Linux instance, Amazon GameLift returns a user name and RSA private +// key, also as strings, for use with an SSH client. The private key must be +// saved in the proper format to a .pem file before using. If you're making +// this request using the CLI, saving the secret can be handled as part of the +// GetInstanceAccess request, as shown in one of the examples for this operation. // // To request access to a specific instance, specify the IDs of both the instance // and the fleet it belongs to. @@ -7938,10 +7944,11 @@ func (c *GameLift) GetComputeAuthTokenRequest(input *GetComputeAuthTokenInput) ( // GetComputeAuthToken API operation for Amazon GameLift. // -// Requests an authorization token from GameLift. The authorization token is -// used by your game server to authenticate with GameLift. Each authentication -// token has an expiration token. To continue using the compute resource to -// host your game server, regularly retrieve a new authorization token. +// Requests an authentication token from Amazon GameLift. The authentication +// token is used by your game server to authenticate with Amazon GameLift. Each +// authentication token has an expiration time. To continue using the compute +// resource to host your game server, regularly retrieve a new authorization +// token. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8034,8 +8041,9 @@ func (c *GameLift) GetGameSessionLogUrlRequest(input *GetGameSessionLogUrlInput) // GetGameSessionLogUrl API operation for Amazon GameLift. // // Retrieves the location of stored game session logs for a specified game session. -// When a game session is terminated, GameLift automatically stores the logs -// in Amazon S3 and retains them for 14 days. Use this URL to download the logs. +// When a game session is terminated, Amazon GameLift automatically stores the +// logs in Amazon S3 and retains them for 14 days. Use this URL to download +// the logs. // // See the Amazon Web Services Service Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift) // page for maximum log file sizes. Log files that exceed this limit are not @@ -8137,13 +8145,13 @@ func (c *GameLift) GetInstanceAccessRequest(input *GetInstanceAccessInput) (req // gathering benchmarking data, or observing activity in real time. // // To remotely access an instance, you need credentials that match the operating -// system of the instance. For a Windows instance, GameLift returns a user name -// and password as strings for use with a Windows Remote Desktop client. For -// a Linux instance, GameLift returns a user name and RSA private key, also -// as strings, for use with an SSH client. The private key must be saved in -// the proper format to a .pem file before using. If you're making this request -// using the CLI, saving the secret can be handled as part of the GetInstanceAccess -// request, as shown in one of the examples for this operation. +// system of the instance. For a Windows instance, Amazon GameLift returns a +// user name and password as strings for use with a Windows Remote Desktop client. +// For a Linux instance, Amazon GameLift returns a user name and RSA private +// key, also as strings, for use with an SSH client. The private key must be +// saved in the proper format to a .pem file before using. If you're making +// this request using the CLI, saving the secret can be handled as part of the +// GetInstanceAccess request, as shown in one of the examples for this operation. // // To request access to a specific instance, specify the IDs of both the instance // and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling @@ -8740,7 +8748,7 @@ func (c *GameLift) ListFleetsRequest(input *ListFleetsInput) (req *request.Reque // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9034,8 +9042,8 @@ func (c *GameLift) ListGameServersRequest(input *ListGameServersInput) (req *req // ListGameServers API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Retrieves information on all game servers that are currently active in a // specified game server group. You can opt to sort the list by game server @@ -9044,7 +9052,7 @@ func (c *GameLift) ListGameServersRequest(input *ListGameServersInput) (req *req // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9482,24 +9490,10 @@ func (c *GameLift) ListTagsForResourceRequest(input *ListTagsForResourceInput) ( // ListTagsForResource API operation for Amazon GameLift. // -// Retrieves all tags that are assigned to a GameLift resource. Resource tags -// are used to organize Amazon Web Services resources for a range of purposes. -// This operation handles the permissions necessary to manage tags for the following -// GameLift resource types: -// -// - Build -// -// - Script -// -// - Fleet -// -// - Alias -// -// - GameSessionQueue -// -// - MatchmakingConfiguration -// -// - MatchmakingRuleSet +// Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags +// to organize Amazon Web Services resources for a range of purposes. This operation +// handles the permissions necessary to manage tags for Amazon GameLift resources +// that support tagging. // // To list tags for a resource, specify the unique ARN value for the resource. // @@ -9768,8 +9762,8 @@ func (c *GameLift) RegisterComputeRequest(input *RegisterComputeInput) (req *req // // Registers your compute resources in a fleet you previously created. After // you register a compute to your fleet, you can monitor and manage your compute -// using GameLift. The operation returns the compute resource containing SDK -// endpoint you can use to connect your game server to GameLift. +// using Amazon GameLift. The operation returns the compute resource containing +// SDK endpoint you can use to connect your game server to Amazon GameLift. // // Learn more // @@ -9868,15 +9862,15 @@ func (c *GameLift) RegisterGameServerRequest(input *RegisterGameServerInput) (re // RegisterGameServer API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // -// Creates a new game server resource and notifies GameLift FleetIQ that the -// game server is ready to host gameplay and players. This operation is called -// by a game server process that is running on an instance in a game server -// group. Registering game servers enables GameLift FleetIQ to track available -// game servers and enables game clients and services to claim a game server -// for a new game session. +// Creates a new game server resource and notifies Amazon GameLift FleetIQ that +// the game server is ready to host gameplay and players. This operation is +// called by a game server process that is running on an instance in a game +// server group. Registering game servers enables Amazon GameLift FleetIQ to +// track available game servers and enables game clients and services to claim +// a game server for a new game session. // // To register a game server, identify the game server group and instance where // the game server is running, and provide a unique identifier for the game @@ -9889,7 +9883,7 @@ func (c *GameLift) RegisterGameServerRequest(input *RegisterGameServerInput) (re // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10193,8 +10187,8 @@ func (c *GameLift) ResumeGameServerGroupRequest(input *ResumeGameServerGroupInpu // ResumeGameServerGroup API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Reinstates activity on a game server group after it has been suspended. A // game server group might be suspended by the SuspendGameServerGroup (gamelift/latest/apireference/API_SuspendGameServerGroup.html) @@ -10210,7 +10204,7 @@ func (c *GameLift) ResumeGameServerGroupRequest(input *ResumeGameServerGroupInpu // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10543,13 +10537,13 @@ func (c *GameLift) StartFleetActionsRequest(input *StartFleetActionsInput) (req // - To restart actions on instances in one of the fleet's remote locations, // provide a fleet ID, a location name, and the type of actions to resume. // -// If successful, GameLift once again initiates scaling events as triggered +// If successful, Amazon GameLift once again initiates scaling events as triggered // by the fleet's scaling policies. If actions on the fleet location were never // stopped, this operation will have no effect. // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10785,8 +10779,8 @@ func (c *GameLift) StartMatchBackfillRequest(input *StartMatchBackfillInput) (re // in the game session. FlexMatch uses this information to select new players // so that backfilled match continues to meet the original match requirements. // -// When using FlexMatch with GameLift managed hosting, you can request a backfill -// match from a client service by calling this operation with a GameSessions +// When using FlexMatch with Amazon GameLift managed hosting, you can request +// a backfill match from a client service by calling this operation with a GameSessions // ID. You also have the option of making backfill requests directly from your // game server. In response to a request, FlexMatch creates player sessions // for the new players, updates the GameSession resource, and sends updated @@ -10816,7 +10810,7 @@ func (c *GameLift) StartMatchBackfillRequest(input *StartMatchBackfillInput) (re // Matchmaking events (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html) // (reference) // -// How GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) +// How Amazon GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10909,13 +10903,13 @@ func (c *GameLift) StartMatchmakingRequest(input *StartMatchmakingInput) (req *r // StartMatchmaking API operation for Amazon GameLift. // // Uses FlexMatch to create a game match for a group of players based on custom -// matchmaking rules. With games that use GameLift managed hosting, this operation -// also triggers GameLift to find hosting resources and start a new game session -// for the new match. Each matchmaking request includes information on one or -// more players and specifies the FlexMatch matchmaker to use. When a request -// is for multiple players, FlexMatch attempts to build a match that includes -// all players in the request, placing them in the same team and finding additional -// players as needed to fill the match. +// matchmaking rules. With games that use Amazon GameLift managed hosting, this +// operation also triggers Amazon GameLift to find hosting resources and start +// a new game session for the new match. Each matchmaking request includes information +// on one or more players and specifies the FlexMatch matchmaker to use. When +// a request is for multiple players, FlexMatch attempts to build a match that +// includes all players in the request, placing them in the same team and finding +// additional players as needed to fill the match. // // To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, // and include the players to be matched. You must also include any player attributes @@ -10933,7 +10927,7 @@ func (c *GameLift) StartMatchmakingRequest(input *StartMatchmakingInput) (req *r // // Set Up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) // -// How GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) +// How Amazon GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11042,12 +11036,12 @@ func (c *GameLift) StopFleetActionsRequest(input *StopFleetActionsInput) (req *r // - To stop actions on instances in one of the fleet's remote locations, // provide a fleet ID, a location name, and the type of actions to suspend. // -// If successful, GameLift no longer initiates scaling events except in response -// to manual changes using UpdateFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html). +// If successful, Amazon GameLift no longer initiates scaling events except +// in response to manual changes using UpdateFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html). // // # Learn more // -// Setting up GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11343,8 +11337,8 @@ func (c *GameLift) SuspendGameServerGroupRequest(input *SuspendGameServerGroupIn // SuspendGameServerGroup API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // // Temporarily stops activity on a game server group without terminating instances // or the game server group. You can restart activity by calling ResumeGameServerGroup @@ -11366,7 +11360,7 @@ func (c *GameLift) SuspendGameServerGroupRequest(input *SuspendGameServerGroupIn // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11459,31 +11453,15 @@ func (c *GameLift) TagResourceRequest(input *TagResourceInput) (req *request.Req // TagResource API operation for Amazon GameLift. // -// Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide -// an additional management tool set. You can use tags to organize resources, -// create IAM permissions policies to manage access to groups of resources, -// customize Amazon Web Services cost breakdowns, etc. This operation handles -// the permissions necessary to manage tags for the following GameLift resource -// types: -// -// - Build -// -// - Script -// -// - Fleet -// -// - Alias -// -// - GameSessionQueue -// -// - MatchmakingConfiguration -// -// - MatchmakingRuleSet +// Assigns a tag to an Amazon GameLift resource. You can use tags to organize +// resources, create IAM permissions policies to manage access to groups of +// resources, customize Amazon Web Services cost breakdowns, and more. This +// operation handles the permissions necessary to manage tags for Amazon GameLift +// resources that support tagging. // // To add a tag to a resource, specify the unique ARN value for the resource // and provide a tag list containing one or more tags. The operation succeeds -// even if the list includes tags that are already assigned to the specified -// resource. +// even if the list includes tags that are already assigned to the resource. // // # Learn more // @@ -11589,29 +11567,14 @@ func (c *GameLift) UntagResourceRequest(input *UntagResourceInput) (req *request // UntagResource API operation for Amazon GameLift. // -// Removes a tag that is assigned to a GameLift resource. Resource tags are -// used to organize Amazon Web Services resources for a range of purposes. This -// operation handles the permissions necessary to manage tags for the following -// GameLift resource types: -// -// - Build -// -// - Script -// -// - Fleet -// -// - Alias -// -// - GameSessionQueue -// -// - MatchmakingConfiguration -// -// - MatchmakingRuleSet +// Removes a tag assigned to a Amazon GameLift resource. You can use resource +// tags to organize Amazon Web Services resources for a range of purposes. This +// operation handles the permissions necessary to manage tags for Amazon GameLift +// resources that support tagging. // // To remove a tag from a resource, specify the unique ARN value for the resource -// and provide a string list containing one or more tags to be removed. This -// operation succeeds even if the list includes tags that are not currently -// assigned to the specified resource. +// and provide a string list containing one or more tags to remove. This operation +// succeeds even if the list includes tags that aren't assigned to the resource. // // # Learn more // @@ -11926,7 +11889,7 @@ func (c *GameLift) UpdateFleetAttributesRequest(input *UpdateFleetAttributesInpu // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12038,9 +12001,9 @@ func (c *GameLift) UpdateFleetCapacityRequest(input *UpdateFleetCapacityInput) ( // be hosted based on the fleet configuration. Use this operation to set the // following fleet capacity properties: // -// - Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot -// set the fleet's capacity to a value outside of this range, whether the -// capacity is changed manually or through automatic scaling. +// - Minimum/maximum size: Set hard limits on fleet capacity. Amazon GameLift +// cannot set the fleet's capacity to a value outside of this range, whether +// the capacity is changed manually or through automatic scaling. // // - Desired capacity: Manually set the number of Amazon EC2 instances to // be maintained in a fleet location. Before changing a fleet's desired capacity, @@ -12059,10 +12022,10 @@ func (c *GameLift) UpdateFleetCapacityRequest(input *UpdateFleetCapacityInput) ( // status. // // If successful, capacity settings are updated immediately. In response a change -// in desired capacity, GameLift initiates steps to start new instances or terminate -// existing instances in the requested fleet location. This continues until -// the location's active instance count matches the new desired instance count. -// You can track a fleet's current capacity by calling DescribeFleetCapacity +// in desired capacity, Amazon GameLift initiates steps to start new instances +// or terminate existing instances in the requested fleet location. This continues +// until the location's active instance count matches the new desired instance +// count. You can track a fleet's current capacity by calling DescribeFleetCapacity // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) // or DescribeFleetLocationCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html). // If the requested desired instance count is higher than the instance type's @@ -12194,7 +12157,7 @@ func (c *GameLift) UpdateFleetPortSettingsRequest(input *UpdateFleetPortSettings // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12300,12 +12263,12 @@ func (c *GameLift) UpdateGameServerRequest(input *UpdateGameServerInput) (req *r // UpdateGameServer API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // -// Updates information about a registered game server to help GameLift FleetIQ -// to track game server availability. This operation is called by a game server -// process that is running on an instance in a game server group. +// Updates information about a registered game server to help Amazon GameLift +// FleetIQ to track game server availability. This operation is called by a +// game server process that is running on an instance in a game server group. // // Use this operation to update the following types of game server information. // You can make all three types of updates in the same request: @@ -12329,7 +12292,7 @@ func (c *GameLift) UpdateGameServerRequest(input *UpdateGameServerInput) (req *r // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12421,22 +12384,22 @@ func (c *GameLift) UpdateGameServerGroupRequest(input *UpdateGameServerGroupInpu // UpdateGameServerGroup API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// server groups. // -// Updates GameLift FleetIQ-specific properties for a game server group. Many -// Auto Scaling group properties are updated on the Auto Scaling group directly, -// including the launch template, Auto Scaling policies, and maximum/minimum/desired +// Updates Amazon GameLift FleetIQ-specific properties for a game server group. +// Many Auto Scaling group properties are updated on the Auto Scaling group +// directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired // instance counts. // // To update the game server group, specify the game server group ID and provide // the updated values. Before applying the updates, the new values are validated -// to ensure that GameLift FleetIQ can continue to perform instance balancing +// to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing // activity. If successful, a GameServerGroup object is returned. // // # Learn more // -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12836,9 +12799,9 @@ func (c *GameLift) UpdateRuntimeConfigurationRequest(input *UpdateRuntimeConfigu // UpdateRuntimeConfiguration API operation for Amazon GameLift. // // Updates the current runtime configuration for the specified fleet, which -// tells GameLift how to launch server processes on all instances in the fleet. -// You can update a fleet's runtime configuration at any time after the fleet -// is created; it does not need to be in ACTIVE status. +// tells Amazon GameLift how to launch server processes on all instances in +// the fleet. You can update a fleet's runtime configuration at any time after +// the fleet is created; it does not need to be in ACTIVE status. // // To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration // with an updated set of server process configurations. @@ -12852,7 +12815,7 @@ func (c *GameLift) UpdateRuntimeConfigurationRequest(input *UpdateRuntimeConfigu // // # Learn more // -// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13221,8 +13184,8 @@ type Alias struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift alias resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift alias resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. // In a GameLift alias ARN, the resource ID matches the alias ID value. AliasArn *string `type:"string"` @@ -13309,13 +13272,14 @@ func (s *Alias) SetRoutingStrategy(v *RoutingStrategy) *Alias { return s } -// GameLift Anywhere configuration options for your Anywhere fleets. +// Amazon GameLift Anywhere configuration options for your Anywhere fleets. type AnywhereConfiguration struct { _ struct{} `type:"structure"` - // The cost to run your fleet per hour. GameLift uses the provided cost of your - // fleet to balance usage in queues. For more information about queues, see - // Setting up queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html). + // The cost to run your fleet per hour. Amazon GameLift uses the provided cost + // of your fleet to balance usage in queues. For more information about queues, + // see Setting up queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) + // in the Amazon GameLift Developer Guide. // // Cost is a required field Cost *string `min:"1" type:"string" required:"true"` @@ -13499,8 +13463,8 @@ type Build struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // assigned to a GameLift build resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // assigned to a Amazon GameLift build resource and uniquely identifies it. + // ARNs are unique across all Regions. Format is arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. // In a GameLift build ARN, the resource ID matches the BuildId value. BuildArn *string `type:"string"` @@ -13511,7 +13475,7 @@ type Build struct { // expressed in Unix time as milliseconds (for example "1469498468.057"). CreationTime *time.Time `type:"timestamp"` - // A descriptive label associated with a build. Build names do not need to be + // A descriptive label associated with a build. Build names don't need to be // unique. It can be set using CreateBuild (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html) // or UpdateBuild (https://docs.aws.amazon.com/gamelift/latest/apireference/UpdateBuild). Name *string `type:"string"` @@ -13520,7 +13484,7 @@ type Build struct { // value determines the type of fleet resources that you can use for this build. OperatingSystem *string `type:"string" enum:"OperatingSystem"` - // The GameLift Server SDK version used to develop your game server. + // The Amazon GameLift Server SDK version used to develop your game server. ServerSdkVersion *string `type:"string"` // File size of the uploaded game build, expressed in bytes. When the build @@ -13544,8 +13508,8 @@ type Build struct { // for this build. Status *string `type:"string" enum:"BuildStatus"` - // Version information associated with a build or script. Version strings do - // not need to be unique. + // Version information associated with a build or script. Version strings don't + // need to be unique. Version *string `type:"string"` } @@ -13623,8 +13587,8 @@ func (s *Build) SetVersion(v string) *Build { // Determines whether a TLS/SSL certificate is generated for a fleet. This feature // must be enabled when creating the fleet. All instances in a fleet share the -// same certificate. The certificate can be retrieved by calling the GameLift -// Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) +// same certificate. The certificate can be retrieved by calling the Amazon +// GameLift Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) // operation GetInstanceCertificate. type CertificateConfiguration struct { _ struct{} `type:"structure"` @@ -13689,14 +13653,15 @@ type ClaimGameServerInput struct { // A unique identifier for the game server group where the game server is running. // If you are not specifying a game server to claim, this value identifies where - // you want GameLift FleetIQ to look for an available game server to claim. + // you want Amazon GameLift FleetIQ to look for an available game server to + // claim. // // GameServerGroupName is a required field GameServerGroupName *string `min:"1" type:"string" required:"true"` // A custom string that uniquely identifies the game server to claim. If this - // parameter is left empty, GameLift FleetIQ searches for an available game - // server in the specified game server group. + // parameter is left empty, Amazon GameLift FleetIQ searches for an available + // game server in the specified game server group. GameServerId *string `min:"3" type:"string"` } @@ -13790,7 +13755,7 @@ func (s *ClaimGameServerOutput) SetGameServer(v *GameServer) *ClaimGameServerOut } // Resources used to host your game servers. A compute resource can be managed -// GameLift Amazon EC2 instances or your own resources. +// Amazon GameLift Amazon EC2 instances or your own resources. type Compute struct { _ struct{} `type:"structure"` @@ -13810,8 +13775,8 @@ type Compute struct { // expressed in Unix time as milliseconds (for example "1469498468.057"). CreationTime *time.Time `type:"timestamp"` - // The DNS name of the compute resource. GameLift requires the DNS name or IP - // address to manage your compute resource. + // The DNS name of the compute resource. Amazon GameLift requires the DNS name + // or IP address to manage your compute resource. DnsName *string `type:"string"` // The Amazon Resource Name (ARN) of the fleet that the compute is registered @@ -13821,12 +13786,12 @@ type Compute struct { // A unique identifier for the fleet that the compute is registered to. FleetId *string `type:"string"` - // The endpoint connection details of the GameLift SDK endpoint that your game - // server connects to. + // The endpoint connection details of the Amazon GameLift SDK endpoint that + // your game server connects to. GameLiftServiceSdkEndpoint *string `min:"1" type:"string"` - // The IP address of the compute resource. GameLift requires the DNS name or - // IP address to manage your compute resource. + // The IP address of the compute resource. Amazon GameLift requires the DNS + // name or IP address to manage your compute resource. IpAddress *string `min:"1" type:"string"` // The name of the custom location you added to the fleet that this compute @@ -13836,8 +13801,8 @@ type Compute struct { // The type of operating system on your compute resource. OperatingSystem *string `type:"string" enum:"OperatingSystem"` - // Which compute type that the fleet uses. A fleet can use Anywhere compute - // resources owned by you or managed Amazon EC2 instances. + // The compute type that the fleet uses. A fleet can use Anywhere compute resources + // that you own, or use managed Amazon EC2 instances. Type *string `type:"string" enum:"EC2InstanceType"` } @@ -14131,21 +14096,22 @@ func (s *CreateAliasOutput) SetAlias(v *Alias) *CreateAliasOutput { type CreateBuildInput struct { _ struct{} `type:"structure"` - // A descriptive label associated with a build. Build names do not need to be + // A descriptive label associated with a build. Build names don't need to be // unique. You can change this value later. Name *string `min:"1" type:"string"` // The operating system that you built the game server binaries to run on. This // value determines the type of fleet resources that you can use for this build. // If your game build contains multiple executables, they all must run on the - // same operating system. If an operating system is not specified when creating - // a build, GameLift uses the default value (WINDOWS_2012). This value cannot - // be changed later. + // same operating system. If an operating system isn't specified when creating + // a build, Amazon GameLift uses the default value (WINDOWS_2012). This value + // can't be changed later. OperatingSystem *string `type:"string" enum:"OperatingSystem"` // A server SDK version you used when integrating your game server build with - // GameLift. For more information see Integrate games with custom game servers - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html). + // Amazon GameLift. For more information see Integrate games with custom game + // servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html). + // By default Amazon GameLift sets this value to 4.0.2. ServerSdkVersion *string `type:"string"` // Information indicating where your game build files are stored. Use this parameter @@ -14171,8 +14137,8 @@ type CreateBuildInput struct { // See the Amazon Web Services General Reference for actual tagging limits. Tags []*Tag `type:"list"` - // Version information associated with a build or script. Version strings do - // not need to be unique. You can change this value later. + // Version information associated with a build or script. Version strings don't + // need to be unique. You can change this value later. Version *string `min:"1" type:"string"` } @@ -14321,18 +14287,19 @@ func (s *CreateBuildOutput) SetUploadCredentials(v *AwsCredentials) *CreateBuild type CreateFleetInput struct { _ struct{} `type:"structure"` - // GameLift Anywhere configuration options. + // Amazon GameLift Anywhere configuration options. AnywhereConfiguration *AnywhereConfiguration `type:"structure"` // The unique identifier for a custom game server build to be deployed on fleet // instances. You can use either the build ID or ARN. The build must be uploaded - // to GameLift and in READY status. This fleet property cannot be changed later. + // to Amazon GameLift and in READY status. This fleet property cannot be changed + // later. BuildId *string `type:"string"` - // Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift - // uses the certificates to encrypt traffic between game clients and the game - // servers running on GameLift. By default, the CertificateConfiguration is - // DISABLED. You can't change this property after you create the fleet. + // Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. + // Amazon GameLift uses the certificates to encrypt traffic between game clients + // and the game servers running on Amazon GameLift. By default, the CertificateConfiguration + // is DISABLED. You can't change this property after you create the fleet. // // Certificate Manager (ACM) certificates expire after 13 months. Certificate // expiration can cause fleets to fail, preventing players from connecting to @@ -14347,8 +14314,9 @@ type CreateFleetInput struct { CertificateConfiguration *CertificateConfiguration `type:"structure"` // The type of compute resource used to host your game servers. You can use - // your own compute resources with GameLift Anywhere or use Amazon EC2 instances - // with managed GameLift. + // your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 + // instances with managed Amazon GameLift. By default, this property is set + // to EC2. ComputeType *string `type:"string" enum:"ComputeType"` // A description for the fleet. @@ -14357,13 +14325,14 @@ type CreateFleetInput struct { // The allowed IP address ranges and port settings that allow inbound traffic // to access game sessions on this fleet. If the fleet is hosting a custom game // build, this property must be set before players can connect to game sessions. - // For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges. + // For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP + // ranges. EC2InboundPermissions []*IpPermission `type:"list"` - // The GameLift-supported Amazon EC2 instance type to use for all fleet instances. - // Instance type determines the computing resources that will be used to host - // your game servers, including CPU, memory, storage, and networking capacity. - // See Amazon Elastic Compute Cloud Instance Types (http://aws.amazon.com/ec2/instance-types/) + // The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet + // instances. Instance type determines the computing resources that will be + // used to host your game servers, including CPU, memory, storage, and networking + // capacity. See Amazon Elastic Compute Cloud Instance Types (http://aws.amazon.com/ec2/instance-types/) // for detailed descriptions of Amazon EC2 instance types. EC2InstanceType *string `type:"string" enum:"EC2InstanceType"` @@ -14387,16 +14356,19 @@ type CreateFleetInput struct { // A set of remote locations to deploy additional instances to and manage as // part of the fleet. This parameter can only be used when creating fleets in // Amazon Web Services Regions that support multiple locations. You can add - // any GameLift-supported Amazon Web Services Region as a remote location, in - // the form of an Amazon Web Services Region code such as us-west-2. To create - // a fleet with instances in the home Region only, omit this parameter. + // any Amazon GameLift-supported Amazon Web Services Region as a remote location, + // in the form of an Amazon Web Services Region code such as us-west-2. To create + // 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 request. Locations []*LocationConfiguration `min:"1" type:"list"` - // This parameter is no longer used. To specify where GameLift should store - // log files once a server process shuts down, use the GameLift server API ProcessReady() - // and specify one or more directory paths in logParameters. For more information, - // see Initialize the server process (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize) - // in the GameLift Developer Guide. + // This parameter is no longer used. To specify where Amazon GameLift should + // store log files once a server process shuts down, use the Amazon GameLift + // server API ProcessReady() and specify one or more directory paths in logParameters. + // For more information, see Initialize the server process (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize) + // in the Amazon GameLift Developer Guide. LogPaths []*string `type:"list"` // The name of an Amazon Web Services CloudWatch metric group to add this fleet @@ -14423,16 +14395,16 @@ type CreateFleetInput struct { // during a scale-down event. NewGameSessionProtectionPolicy *string `type:"string" enum:"ProtectionPolicy"` - // Used when peering your GameLift fleet with a VPC, the unique identifier for - // the Amazon Web Services account that owns the VPC. You can find your account - // ID in the Amazon Web Services Management Console under account settings. + // Used when peering your Amazon GameLift fleet with a VPC, the unique identifier + // for the Amazon Web Services account that owns the VPC. You can find your + // account ID in the Amazon Web Services Management Console under account settings. PeerVpcAwsAccountId *string `min:"1" type:"string"` - // A unique identifier for a VPC with resources to be accessed by your GameLift - // fleet. The VPC must be in the same Region as your fleet. To look up a VPC - // ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon - // Web Services Management Console. Learn more about VPC peering in VPC Peering - // with GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // A unique identifier for a VPC with resources to be accessed by your Amazon + // GameLift fleet. The VPC must be in the same Region as your fleet. To look + // up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) + // in the Amazon Web Services Management Console. Learn more about VPC peering + // in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). PeerVpcId *string `min:"1" type:"string"` // A policy that limits the number of game sessions that an individual player @@ -14451,7 +14423,7 @@ type CreateFleetInput struct { // The unique identifier for a Realtime configuration script to be deployed // on fleet instances. You can use either the script ID or ARN. Scripts must - // be uploaded to GameLift prior to creating the fleet. This fleet property + // be uploaded to Amazon GameLift prior to creating the fleet. This fleet property // cannot be changed later. ScriptId *string `type:"string"` @@ -14715,9 +14687,9 @@ type CreateFleetLocationsInput struct { FleetId *string `type:"string" required:"true"` // A list of locations to deploy additional instances to and manage as part - // of the fleet. You can add any GameLift-supported Amazon Web Services Region - // as a remote location, in the form of an Amazon Web Services Region code such - // as us-west-2. + // of the fleet. You can add any Amazon GameLift-supported Amazon Web Services + // Region as a remote location, in the form of an Amazon Web Services Region + // code such as us-west-2. // // Locations is a required field Locations []*LocationConfiguration `min:"1" type:"list" required:"true"` @@ -14786,8 +14758,8 @@ type CreateFleetLocationsOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that was updated with new locations. @@ -14795,8 +14767,8 @@ type CreateFleetLocationsOutput struct { // The remote locations that are being added to the fleet, and the life-cycle // status of each location. For new locations, the status is set to NEW. During - // location creation, GameLift updates each location's status as instances are - // deployed there and prepared for game hosting. This list does not include + // location creation, Amazon GameLift updates each location's status as instances + // are deployed there and prepared for game hosting. This list does not include // the fleet home Region or any remote locations that were already added to // the fleet. LocationStates []*LocationState `type:"list"` @@ -14846,11 +14818,11 @@ type CreateFleetOutput struct { FleetAttributes *FleetAttributes `type:"structure"` // The fleet's locations and life-cycle status of each location. For new fleets, - // the status of all locations is set to NEW. During fleet creation, GameLift - // updates each location status as instances are deployed there and prepared - // for game hosting. This list includes an entry for the fleet's home Region. - // For fleets with no remote locations, only one entry, representing the home - // Region, is returned. + // the status of all locations is set to NEW. During fleet creation, Amazon + // GameLift updates each location status as instances are deployed there and + // prepared for game hosting. This list includes an entry for the fleet's home + // Region. For fleets with no remote locations, only one entry, representing + // the home Region, is returned. LocationStates []*LocationState `type:"list"` } @@ -14895,8 +14867,9 @@ type CreateGameServerGroupInput struct { // or APIs. AutoScalingPolicy *GameServerGroupAutoScalingPolicy `type:"structure"` - // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand - // Instances in the game server group. Method options include the following: + // Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances + // and On-Demand Instances in the game server group. Method options include + // the following: // // * SPOT_ONLY - Only Spot Instances are used in the game server group. If // Spot Instances are unavailable or not viable for game hosting, the game @@ -14917,9 +14890,9 @@ type CreateGameServerGroupInput struct { BalancingStrategy *string `type:"string" enum:"BalancingStrategy"` // An identifier for the new game server group. This value is used to generate - // unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift - // FleetIQ game server group. The name must be unique per Region per Amazon - // Web Services account. + // unique ARN identifiers for the Amazon EC2 Auto Scaling group and the Amazon + // GameLift FleetIQ game server group. The name must be unique per Region per + // Amazon Web Services account. // // GameServerGroupName is a required field GameServerGroupName *string `min:"1" type:"string" required:"true"` @@ -14936,7 +14909,7 @@ type CreateGameServerGroupInput struct { // The Amazon EC2 instance types and sizes to use in the Auto Scaling group. // The instance definitions must specify at least two different instance types - // that are supported by GameLift FleetIQ. For more information on instance + // that are supported by Amazon GameLift FleetIQ. For more information on instance // types, see EC2 Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) // in the Amazon Elastic Compute Cloud User Guide. You can optionally specify // capacity weighting for each instance type. If no weight value is specified @@ -14959,26 +14932,26 @@ type CreateGameServerGroupInput struct { // // If you specify network interfaces in your launch template, you must explicitly // set the property AssociatePublicIpAddress to "true". If no network interface - // is specified in the launch template, GameLift FleetIQ uses your account's + // is specified in the launch template, Amazon GameLift FleetIQ uses your account's // default VPC. // // LaunchTemplate is a required field LaunchTemplate *LaunchTemplateSpecification `type:"structure" required:"true"` // The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. - // During automatic scaling events, GameLift FleetIQ and EC2 do not scale up - // the group above this maximum. After the Auto Scaling group is created, update - // this value directly in the Auto Scaling group using the Amazon Web Services - // console or APIs. + // During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale + // up the group above this maximum. After the Auto Scaling group is created, + // update this value directly in the Auto Scaling group using the Amazon Web + // Services console or APIs. // // MaxSize is a required field MaxSize *int64 `min:"1" type:"integer" required:"true"` // The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. - // During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale - // down the group below this minimum. In production, this value should be set - // to at least 1. After the Auto Scaling group is created, update this value - // directly in the Auto Scaling group using the Amazon Web Services console + // During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do + // not scale down the group below this minimum. In production, this value should + // be set to at least 1. After the Auto Scaling group is created, update this + // value directly in the Auto Scaling group using the Amazon Web Services console // or APIs. // // MinSize is a required field @@ -14999,7 +14972,7 @@ type CreateGameServerGroupInput struct { Tags []*Tag `type:"list"` // A list of virtual private cloud (VPC) subnets to use with instances in the - // game server group. By default, all GameLift FleetIQ-supported Availability + // game server group. By default, all Amazon GameLift FleetIQ-supported Availability // Zones are used. You can use this parameter to specify VPCs that you've set // up. This property cannot be updated after the game server group is created, // and the corresponding Auto Scaling group will always use the property value @@ -15169,10 +15142,10 @@ type CreateGameServerGroupOutput struct { _ struct{} `type:"structure"` // The newly created game server group object, including the new ARN value for - // the GameLift FleetIQ game server group and the object's status. The Amazon - // EC2 Auto Scaling group ARN is initially null, since the group has not yet - // been created. This value is added once the game server group status reaches - // ACTIVE. + // the Amazon GameLift FleetIQ game server group and the object's status. The + // Amazon EC2 Auto Scaling group ARN is initially null, since the group has + // not yet been created. This value is added once the game server group status + // reaches ACTIVE. GameServerGroup *GameServerGroup `type:"structure"` } @@ -15208,12 +15181,18 @@ type CreateGameSessionInput struct { // reference either a fleet ID or alias ID, but not both. AliasId *string `type:"string"` - // A unique identifier for a player or entity creating the game session. This - // parameter is required when requesting a new game session on a fleet with - // a resource creation limit policy. This type of policy limits the number of - // concurrent active game sessions that one player can create within a certain - // time span. GameLift uses the CreatorId to evaluate the new request against - // the policy. + // A unique identifier for a player or entity creating the game session. + // + // If you add a resource creation limit policy to a fleet, the CreateGameSession + // operation requires a CreatorId. Amazon GameLift limits the number of game + // session creation requests with the same CreatorId in a specified time period. + // + // If you your fleet doesn't have a resource creation limit policy and you provide + // a CreatorId in your CreateGameSession requests, Amazon GameLift limits requests + // to one request per CreatorId per second. + // + // To not limit CreateGameSession requests with the same CreatorId, don't provide + // a CreatorId in your CreateGameSession request. CreatorId *string `min:"1" type:"string"` // A unique identifier for the fleet to create a game session in. You can use @@ -15745,10 +15724,10 @@ type CreateMatchmakingConfigurationInput struct { // The method used to backfill game sessions that are created with this matchmaking // configuration. Specify MANUAL when your game manages backfill requests manually - // or does not use the match backfill feature. Specify AUTOMATIC to have GameLift - // create a backfill request whenever a game session has one or more open slots. - // Learn more about manual and automatic backfill in Backfill Existing Games - // with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html). + // or does not use the match backfill feature. Specify AUTOMATIC to have Amazon + // GameLift create a backfill request whenever a game session has one or more + // open slots. Learn more about manual and automatic backfill in Backfill Existing + // Games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html). // Automatic backfill is not available when FlexMatchMode is set to STANDALONE. BackfillMode *string `type:"string" enum:"BackfillMode"` @@ -15758,14 +15737,14 @@ type CreateMatchmakingConfigurationInput struct { // A human-readable description of the matchmaking configuration. Description *string `min:"1" type:"string"` - // Indicates whether this matchmaking configuration is being used with GameLift - // hosting or as a standalone matchmaking solution. + // Indicates whether this matchmaking configuration is being used with Amazon + // GameLift hosting or as a standalone matchmaking solution. // // * STANDALONE - FlexMatch forms matches and returns match information, // including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) // event. // - // * WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift + // * WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift // queue to start a game session for the match. FlexMatchMode *string `type:"string" enum:"FlexMatchMode"` @@ -15786,11 +15765,12 @@ type CreateMatchmakingConfigurationInput struct { GameSessionData *string `min:"1" type:"string"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift game session queue resource and uniquely identifies - // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/::gamesessionqueue/. Queues can be located in any Region. Queues are used to start new - // GameLift-hosted game sessions for matches that are created with this matchmaking - // configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter. + // Amazon GameLift-hosted game sessions for matches that are created with this + // matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not + // set this parameter. GameSessionQueueArns []*string `type:"list"` // A unique identifier for the matchmaking configuration. This name is used @@ -16152,8 +16132,8 @@ type CreatePlayerSessionInput struct { // GameSessionId is a required field GameSessionId *string `min:"1" type:"string" required:"true"` - // Developer-defined information related to a player. GameLift does not use - // this data, so it can be formatted as needed for use in the game. + // Developer-defined information related to a player. Amazon GameLift does not + // use this data, so it can be formatted as needed for use in the game. PlayerData *string `min:"1" type:"string"` // A unique identifier for a player. Player IDs are developer-defined. @@ -16366,7 +16346,7 @@ func (s *CreatePlayerSessionsOutput) SetPlayerSessions(v []*PlayerSession) *Crea type CreateScriptInput struct { _ struct{} `type:"structure"` - // A descriptive label that is associated with a script. Script names do not + // A descriptive label that is associated with a script. Script names don't // need to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) // to change this value later. Name *string `min:"1" type:"string"` @@ -16393,8 +16373,8 @@ type CreateScriptInput struct { // See the Amazon Web Services General Reference for actual tagging limits. Tags []*Tag `type:"list"` - // Version information associated with a build or script. Version strings do - // not need to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) + // Version information associated with a build or script. Version strings don't + // need to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) // to change this value later. Version *string `min:"1" type:"string"` @@ -16529,17 +16509,17 @@ type CreateVpcPeeringAuthorizationInput struct { _ struct{} `type:"structure"` // A unique identifier for the Amazon Web Services account that you use to manage - // your GameLift fleet. You can find your Account ID in the Amazon Web Services - // Management Console under account settings. + // your Amazon GameLift fleet. You can find your Account ID in the Amazon Web + // Services Management Console under account settings. // // GameLiftAwsAccountId is a required field GameLiftAwsAccountId *string `min:"1" type:"string" required:"true"` - // A unique identifier for a VPC with resources to be accessed by your GameLift - // fleet. The VPC must be in the same Region as your fleet. To look up a VPC - // ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon - // Web Services Management Console. Learn more about VPC peering in VPC Peering - // with GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // A unique identifier for a VPC with resources to be accessed by your Amazon + // GameLift fleet. The VPC must be in the same Region as your fleet. To look + // up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) + // in the Amazon Web Services Management Console. Learn more about VPC peering + // in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). // // PeerVpcId is a required field PeerVpcId *string `min:"1" type:"string" required:"true"` @@ -16644,11 +16624,11 @@ type CreateVpcPeeringConnectionInput struct { // PeerVpcAwsAccountId is a required field PeerVpcAwsAccountId *string `min:"1" type:"string" required:"true"` - // A unique identifier for a VPC with resources to be accessed by your GameLift - // fleet. The VPC must be in the same Region as your fleet. To look up a VPC - // ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon - // Web Services Management Console. Learn more about VPC peering in VPC Peering - // with GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // A unique identifier for a VPC with resources to be accessed by your Amazon + // GameLift fleet. The VPC must be in the same Region as your fleet. To look + // up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) + // in the Amazon Web Services Management Console. Learn more about VPC peering + // in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). // // PeerVpcId is a required field PeerVpcId *string `min:"1" type:"string" required:"true"` @@ -16991,8 +16971,8 @@ type DeleteFleetLocationsOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that location attributes are being deleted @@ -17613,17 +17593,17 @@ type DeleteVpcPeeringAuthorizationInput struct { _ struct{} `type:"structure"` // A unique identifier for the Amazon Web Services account that you use to manage - // your GameLift fleet. You can find your Account ID in the Amazon Web Services - // Management Console under account settings. + // your Amazon GameLift fleet. You can find your Account ID in the Amazon Web + // Services Management Console under account settings. // // GameLiftAwsAccountId is a required field GameLiftAwsAccountId *string `min:"1" type:"string" required:"true"` - // A unique identifier for a VPC with resources to be accessed by your GameLift - // fleet. The VPC must be in the same Region as your fleet. To look up a VPC - // ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon - // Web Services Management Console. Learn more about VPC peering in VPC Peering - // with GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // A unique identifier for a VPC with resources to be accessed by your Amazon + // GameLift fleet. The VPC must be in the same Region as your fleet. To look + // up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) + // in the Amazon Web Services Management Console. Learn more about VPC peering + // in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). // // PeerVpcId is a required field PeerVpcId *string `min:"1" type:"string" required:"true"` @@ -18211,10 +18191,11 @@ func (s *DescribeComputeOutput) SetCompute(v *Compute) *DescribeComputeOutput { type DescribeEC2InstanceLimitsInput struct { _ struct{} `type:"structure"` - // Name of an Amazon EC2 instance type that is supported in GameLift. A fleet - // instance type determines the computing resources of each instance in the - // fleet, including CPU, memory, storage, and networking capacity. Do not specify - // a value for this parameter to retrieve limits for all instance types. + // Name of an Amazon EC2 instance type that is supported in Amazon GameLift. + // A fleet instance type determines the computing resources of each instance + // in the fleet, including CPU, memory, storage, and networking capacity. Do + // not specify a value for this parameter to retrieve limits for all instance + // types. EC2InstanceType *string `type:"string" enum:"EC2InstanceType"` // The name of a remote location to request instance limits for, in the form @@ -18763,8 +18744,8 @@ type DescribeFleetLocationAttributesOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that location attributes were requested @@ -19080,8 +19061,8 @@ type DescribeFleetPortSettingsOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that was requested. @@ -21153,8 +21134,8 @@ func (s *DescribeVpcPeeringConnectionsOutput) SetVpcPeeringConnections(v []*VpcP type DesiredPlayerSession struct { _ struct{} `type:"structure"` - // Developer-defined information related to a player. GameLift does not use - // this data, so it can be formatted as needed for use in the game. + // Developer-defined information related to a player. Amazon GameLift does not + // use this data, so it can be formatted as needed for use in the game. PlayerData *string `min:"1" type:"string"` // A unique identifier for a player to associate with the player session. @@ -21297,11 +21278,12 @@ func (s *EC2InstanceCounts) SetTERMINATING(v int64) *EC2InstanceCounts { return s } -// The GameLift service limits for an Amazon EC2 instance type and current utilization. -// GameLift allows Amazon Web Services accounts a maximum number of instances, -// per instance type, per Amazon Web Services Region or location, for use with -// GameLift. You can request an limit increase for your account by using the -// Service limits page in the GameLift console. +// The Amazon GameLift service limits for an Amazon EC2 instance type and current +// utilization. Amazon GameLift allows Amazon Web Services accounts a maximum +// number of instances, per instance type, per Amazon Web Services Region or +// location, for use with Amazon GameLift. You can request an limit increase +// for your account by using the Service limits page in the Amazon GameLift +// console. type EC2InstanceLimit struct { _ struct{} `type:"structure"` @@ -21363,9 +21345,9 @@ func (s *EC2InstanceLimit) SetLocation(v string) *EC2InstanceLimit { return s } -// Log entry describing an event that involves GameLift resources (such as a -// fleet). In addition to tracking activity, event codes and messages can provide -// additional information for troubleshooting and debugging problems. +// Log entry describing an event that involves Amazon GameLift resources (such +// as a fleet). In addition to tracking activity, event codes and messages can +// provide additional information for troubleshooting and debugging problems. type Event struct { _ struct{} `type:"structure"` @@ -21380,16 +21362,16 @@ type Event struct { // The compressed build has started downloading to a fleet instance for installation. // // * FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. - // GameLift has successfully downloaded the build and is now validating the - // build files. + // Amazon GameLift has successfully downloaded the build and is now validating + // the build files. // // * FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. - // GameLift has successfully verified the build files and is now running + // Amazon GameLift has successfully verified the build files and is now running // the installation scripts. // // * FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. - // GameLift is trying to launch an instance and test the connectivity between - // the build and the GameLift Service via the Server SDK. + // Amazon GameLift is trying to launch an instance and test the connectivity + // between the build and the Amazon GameLift Service via the Server SDK. // // * FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to // ACTIVE. The fleet is now ready to host game sessions. @@ -21419,8 +21401,8 @@ type Event struct { // * FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, // and the GameLift is now verifying that the game server launch paths, which // are specified in the fleet's runtime configuration, exist. If any listed - // launch path exists, GameLift tries to launch a game server process and - // waits for the process to report ready. Failures in this stage prevent + // launch path exists, Amazon GameLift tries to launch a game server process + // and waits for the process to report ready. Failures in this stage prevent // a fleet from moving to ACTIVE status. Logs for this stage list the launch // paths in the runtime configuration and indicate whether each is found. // Access the logs by using the URL in PreSignedLogUrl. @@ -21453,8 +21435,8 @@ type Event struct { // VPC peering events: // // * FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established - // between the VPC for an GameLift fleet and a VPC in your Amazon Web Services - // account. + // between the VPC for an Amazon GameLift fleet and a VPC in your Amazon + // Web Services account. // // * FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. // Event details and status information provide additional detail. A common @@ -21536,7 +21518,7 @@ type Event struct { // Location of stored logs with additional detail that is related to the event. // This is useful for debugging issues. The URL is valid for 15 minutes. You - // can also access fleet creation logs through the GameLift console. + // can also access fleet creation logs through the Amazon GameLift console. PreSignedLogUrl *string `min:"1" type:"string"` // A unique identifier for an event resource, such as a fleet ID. @@ -21646,17 +21628,17 @@ func (s *FilterConfiguration) SetAllowedLocations(v []*string) *FilterConfigurat return s } -// Describes a GameLift fleet of game hosting resources. +// Describes a Amazon GameLift fleet of game hosting resources. // // Related actions type FleetAttributes struct { _ struct{} `type:"structure"` - // GameLift Anywhere configuration options for your Anywhere fleets. + // Amazon GameLift Anywhere configuration options for your Anywhere fleets. AnywhereConfiguration *AnywhereConfiguration `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // associated with the GameLift build resource that is deployed on instances + // associated with the Amazon GameLift build resource that is deployed on instances // in this fleet. In a GameLift build ARN, the resource ID matches the BuildId // value. BuildArn *string `type:"string"` @@ -21667,14 +21649,14 @@ type FleetAttributes struct { // Determines whether a TLS/SSL certificate is generated for a fleet. This feature // must be enabled when creating the fleet. All instances in a fleet share the - // same certificate. The certificate can be retrieved by calling the GameLift - // Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) + // same certificate. The certificate can be retrieved by calling the Amazon + // GameLift Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) // operation GetInstanceCertificate. CertificateConfiguration *CertificateConfiguration `type:"structure"` // The type of compute resource used to host your game servers. You can use - // your own compute resources with GameLift Anywhere or use Amazon EC2 instances - // with managed GameLift. + // your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 + // instances with managed Amazon GameLift. ComputeType *string `type:"string" enum:"ComputeType"` // A time stamp indicating when this data object was created. Format is a number @@ -21685,8 +21667,8 @@ type FleetAttributes struct { Description *string `min:"1" type:"string"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. // In a GameLift fleet ARN, the resource ID matches the FleetId value. FleetArn *string `type:"string"` @@ -21716,8 +21698,8 @@ type FleetAttributes struct { InstanceType *string `type:"string" enum:"EC2InstanceType"` // This parameter is no longer used. Game session log paths are now defined - // using the GameLift server API ProcessReady() logParameters. See more information - // in the Server API Reference (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process). + // using the Amazon GameLift server API ProcessReady() logParameters. See more + // information in the Server API Reference (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process). LogPaths []*string `type:"list"` // Name of a metric group that metrics for this fleet are added to. In Amazon @@ -21749,9 +21731,9 @@ type FleetAttributes struct { // players' ability to consume available resources. // // The policy is evaluated when a player tries to create a new game session. - // On receiving a CreateGameSession request, GameLift checks that the player - // (identified by CreatorId) has created fewer than game session limit in the - // specified time period. + // On receiving a CreateGameSession request, Amazon GameLift checks that the + // player (identified by CreatorId) has created fewer than game session limit + // in the specified time period. ResourceCreationLimitPolicy *ResourceCreationLimitPolicy `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) @@ -21779,8 +21761,8 @@ type FleetAttributes struct { // * NEW -- A new fleet has been defined and desired instances is set to // 1. // - // * DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up - // the new fleet, creating new instances with the game build or Realtime + // * DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting + // up the new fleet, creating new instances with the game build or Realtime // script and starting server processes. // // * ACTIVE -- Hosts can now accept game sessions. @@ -21982,8 +21964,8 @@ type FleetCapacity struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet associated with the location. @@ -22138,8 +22120,8 @@ type FleetUtilization struct { CurrentPlayerSessionCount *int64 `type:"integer"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet associated with the location. @@ -22219,7 +22201,7 @@ func (s *FleetUtilization) SetMaximumPlayerSessionCount(v int64) *FleetUtilizati // to be used when setting up the new game session. For example, a game property // might specify a game mode, level, or map. Game properties are passed to the // game server process when initiating a new game session. For more information, -// see the GameLift Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create). +// see the Amazon GameLift Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create). type GameProperty struct { _ struct{} `type:"structure"` @@ -22280,7 +22262,7 @@ func (s *GameProperty) SetValue(v string) *GameProperty { return s } -// This data type is used with the GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server groups. // // Properties describing a game server that is running on an instance in a game // server group. @@ -22436,7 +22418,7 @@ func (s *GameServer) SetUtilizationStatus(v string) *GameServer { return s } -// This data type is used with the GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server groups. // // Properties that describe a game server group resource. A game server group // manages certain properties related to a corresponding Amazon EC2 Auto Scaling @@ -22453,8 +22435,9 @@ type GameServerGroup struct { // with this game server group. AutoScalingGroupArn *string `type:"string"` - // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand - // Instances in the game server group. Method options include the following: + // Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances + // and On-Demand Instances in the game server group. Method options include + // the following: // // * SPOT_ONLY - Only Spot Instances are used in the game server group. If // Spot Instances are unavailable or not viable for game hosting, the game @@ -22494,8 +22477,9 @@ type GameServerGroup struct { // which can be terminated by Amazon Web Services regardless of protection status. GameServerProtectionPolicy *string `type:"string" enum:"GameServerProtectionPolicy"` - // The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing - // and automatically scaling instances in the corresponding Auto Scaling group. + // The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use + // when balancing and automatically scaling instances in the corresponding Auto + // Scaling group. InstanceDefinitions []*InstanceDefinition `min:"2" type:"list"` // A timestamp that indicates when this game server group was last updated. @@ -22508,20 +22492,22 @@ type GameServerGroup struct { // The current status of the game server group. Possible statuses include: // - // * NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request. + // * NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() + // request. // - // * ACTIVATING - GameLift FleetIQ is setting up a game server group, which - // includes creating an Auto Scaling group in your Amazon Web Services account. + // * ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, + // which includes creating an Auto Scaling group in your Amazon Web Services + // account. // // * ACTIVE - The game server group has been successfully created. // // * DELETE_SCHEDULED - A request to delete the game server group has been // received. // - // * DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() - // request and is processing it. GameLift FleetIQ must first complete and - // release hosts before it deletes the Auto Scaling group and the game server - // group. + // * DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() + // request and is processing it. Amazon GameLift FleetIQ must first complete + // and release hosts before it deletes the Auto Scaling group and the game + // server group. // // * DELETED - The game server group has been successfully deleted. // @@ -22628,7 +22614,7 @@ func (s *GameServerGroup) SetSuspendedActions(v []*string) *GameServerGroup { return s } -// This data type is used with the GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server groups. // // Configuration settings for intelligent automatic scaling that uses target // tracking. These settings are used to add an Auto Scaling policy when creating @@ -22639,16 +22625,16 @@ type GameServerGroupAutoScalingPolicy struct { _ struct{} `type:"structure"` // Length of time, in seconds, it takes for a new instance to start new game - // server processes and register with GameLift FleetIQ. Specifying a warm-up - // time can be useful, particularly with game servers that take a long time - // to start up, because it avoids prematurely starting new instances. + // server processes and register with Amazon GameLift FleetIQ. Specifying a + // warm-up time can be useful, particularly with game servers that take a long + // time to start up, because it avoids prematurely starting new instances. EstimatedInstanceWarmup *int64 `min:"1" type:"integer"` // Settings for a target-based scaling policy applied to Auto Scaling group. - // These settings are used to create a target-based policy that tracks the GameLift - // FleetIQ metric "PercentUtilizedGameServers" and specifies a target value - // for the metric. As player usage changes, the policy triggers to adjust the - // game server group capacity so that the metric returns to the target value. + // These settings are used to create a target-based policy that tracks the Amazon + // GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target + // value for the metric. As player usage changes, the policy triggers to adjust + // the game server group capacity so that the metric returns to the target value. // // TargetTrackingConfiguration is a required field TargetTrackingConfiguration *TargetTrackingConfiguration `type:"structure" required:"true"` @@ -22705,7 +22691,7 @@ func (s *GameServerGroupAutoScalingPolicy) SetTargetTrackingConfiguration(v *Tar return s } -// This data type is used with the GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server groups. // // Additional properties, including status, that describe an EC2 instance in // a game server group. Instance configurations are set with game server group @@ -22835,8 +22821,8 @@ type GameSession struct { // or idempotency token>. GameSessionId *string `min:"1" type:"string"` - // The IP address of the game session. To connect to a GameLift game server, - // an app needs both the IP address and port number. + // The IP address of the game session. To connect to a Amazon GameLift game + // server, an app needs both the IP address and port number. IpAddress *string `min:"1" type:"string"` // The fleet location where the game session is running. This value might specify @@ -22865,8 +22851,8 @@ type GameSession struct { // Indicates whether or not the game session is accepting new players. PlayerSessionCreationPolicy *string `type:"string" enum:"PlayerSessionCreationPolicy"` - // The port number for the game session. To connect to a GameLift game server, - // an app needs both the IP address and port number. + // The port number for the game session. To connect to a Amazon GameLift game + // server, an app needs both the IP address and port number. Port *int64 `min:"1" type:"integer"` // Current status of the game session. A game session must have an ACTIVE status @@ -23038,16 +23024,16 @@ type GameSessionConnectionInfo struct { // A unique identifier for the game session. Use the game session ID. GameSessionArn *string `min:"1" type:"string"` - // The IP address of the game session. To connect to a GameLift game server, - // an app needs both the IP address and port number. + // The IP address of the game session. To connect to a Amazon GameLift game + // server, an app needs both the IP address and port number. IpAddress *string `min:"1" type:"string"` // A collection of player session IDs, one for each player ID that was included // in the original matchmaking request. MatchedPlayerSessions []*MatchedPlayerSession `type:"list"` - // The port number for the game session. To connect to a GameLift game server, - // an app needs both the IP address and port number. + // The port number for the game session. To connect to a Amazon GameLift game + // server, an app needs both the IP address and port number. Port *int64 `min:"1" type:"integer"` } @@ -23265,9 +23251,9 @@ type GameSessionPlacement struct { // status is FULFILLED). GameSessionRegion *string `min:"1" type:"string"` - // The IP address of the game session. To connect to a GameLift game server, - // an app needs both the IP address and port number. This value is set once - // the new game session is placed (placement status is FULFILLED). + // The IP address of the game session. To connect to a Amazon GameLift game + // server, an app needs both the IP address and port number. This value is set + // once the new game session is placed (placement status is FULFILLED). IpAddress *string `min:"1" type:"string"` // Information on the matchmaking process for this game. Data is in JSON syntax, @@ -23295,9 +23281,9 @@ type GameSessionPlacement struct { // latency that a player experiences when connected to Amazon Web Services Regions. PlayerLatencies []*PlayerLatency `type:"list"` - // The port number for the game session. To connect to a GameLift game server, - // an app needs both the IP address and port number. This value is set once - // the new game session is placed (placement status is FULFILLED). + // The port number for the game session. To connect to a Amazon GameLift game + // server, an app needs both the IP address and port number. This value is set + // once the new game session is placed (placement status is FULFILLED). Port *int64 `min:"1" type:"integer"` // Time stamp indicating when this request was placed in the queue. Format is @@ -23318,9 +23304,9 @@ type GameSessionPlacement struct { // * TIMED_OUT -- A new game session was not successfully created before // the time limit expired. You can resubmit the placement request as needed. // - // * FAILED -- GameLift is not able to complete the process of placing the - // game session. Common reasons are the game session terminated before the - // placement process was completed, or an unexpected internal error. + // * FAILED -- Amazon GameLift is not able to complete the process of placing + // the game session. Common reasons are the game session terminated before + // the placement process was completed, or an unexpected internal error. Status *string `type:"string" enum:"GameSessionPlacementState"` } @@ -23472,10 +23458,10 @@ type GameSessionQueue struct { FilterConfiguration *FilterConfiguration `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift game session queue resource and uniquely identifies - // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. In a GameLift game session queue ARN, the resource ID matches the - // Name value. + // that is assigned to a Amazon GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. In a Amazon GameLift game session queue ARN, the resource ID matches + // the Name value. GameSessionQueueArn *string `min:"1" type:"string"` // A descriptive label that is associated with game session queue. Queue names @@ -23692,8 +23678,8 @@ type GetComputeAccessOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift compute resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift compute resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. ComputeArn *string `type:"string"` // The name of the compute resource you requested credentials for. @@ -23707,8 +23693,8 @@ type GetComputeAccessOutput struct { Credentials *AwsCredentials `type:"structure" sensitive:"true"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // The fleet ID of compute resource. @@ -23766,7 +23752,7 @@ func (s *GetComputeAccessOutput) SetFleetId(v string) *GetComputeAccessOutput { type GetComputeAuthTokenInput struct { _ struct{} `type:"structure"` - // The name of the compute resource you are requesting the authorization token + // The name of the compute resource you are requesting the authentication token // for. // // ComputeName is a required field @@ -23827,26 +23813,27 @@ func (s *GetComputeAuthTokenInput) SetFleetId(v string) *GetComputeAuthTokenInpu type GetComputeAuthTokenOutput struct { _ struct{} `type:"structure"` - // The authorization token that your game server uses to authenticate with GameLift. + // The authentication token that your game server uses to authenticate with + // Amazon GameLift. AuthToken *string `min:"1" type:"string"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift compute resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 + // that is assigned to a Amazon GameLift compute resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 ComputeArn *string `type:"string"` - // The name of the compute resource you are requesting the authorization token + // The name of the compute resource you are requesting the authentication token // for. ComputeName *string `type:"string"` - // The amount of time until the authorization token is no longer valid. To continue - // using the compute resource for game server hosting, renew the authorization + // The amount of time until the authentication token is no longer valid. To + // continue using the compute resource for game server hosting, renew the authentication // token by using this operation again. ExpirationTimestamp *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that the compute is registered to. @@ -24152,7 +24139,8 @@ func (s *IdempotentParameterMismatchException) RequestID() string { } // Represents an EC2 instance of virtual computing resources that hosts one -// or more game servers. In GameLift, a fleet can contain zero or more instances. +// or more game servers. In Amazon GameLift, a fleet can contain zero or more +// instances. // // Related actions type Instance struct { @@ -24175,8 +24163,8 @@ type Instance struct { DnsName *string `type:"string"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that the instance is in. @@ -24201,7 +24189,7 @@ type Instance struct { // server processes as defined in the fleet's run-time configuration. // // * ACTIVE -- The instance has been successfully created and at least one - // server process has successfully launched and reported back to GameLift + // server process has successfully launched and reported back to Amazon GameLift // that it is ready to host a game session. The instance is now considered // ready to host game sessions. // @@ -24407,12 +24395,12 @@ func (s *InstanceCredentials) SetUserName(v string) *InstanceCredentials { return s } -// This data type is used with the GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server groups. // // An allowed instance type for a game server group. All game server groups -// must have at least two instance types defined for it. GameLift FleetIQ periodically -// evaluates each defined instance type for viability. It then updates the Auto -// Scaling group with the list of viable instance types. +// must have at least two instance types defined for it. Amazon GameLift FleetIQ +// periodically evaluates each defined instance type for viability. It then +// updates the Auto Scaling group with the list of viable instance types. type InstanceDefinition struct { _ struct{} `type:"structure"` @@ -24423,8 +24411,8 @@ type InstanceDefinition struct { // Instance weighting that indicates how much this instance type contributes // to the total capacity of a game server group. Instance weights are used by - // GameLift FleetIQ to calculate the instance type's cost per unit hour and - // better identify the most cost-effective options. For detailed information + // Amazon GameLift FleetIQ to calculate the instance type's cost per unit hour + // and better identify the most cost-effective options. For detailed information // on weighting instance capacity, see Instance Weighting (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) // in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value // is "1". @@ -24744,14 +24732,16 @@ func (s *InvalidRequestException) RequestID() string { // to server processes on an instance in a fleet. New game sessions are assigned // an IP address/port number combination, which must fall into the fleet's allowed // ranges. Fleets with custom game builds must have permissions explicitly set. -// For Realtime Servers fleets, GameLift automatically opens two port ranges, -// one for TCP messaging and one for UDP. +// For Realtime Servers fleets, Amazon GameLift automatically opens two port +// ranges, one for TCP messaging and one for UDP. type IpPermission struct { _ struct{} `type:"structure"` // A starting value for a range of allowed port numbers. // - // For fleets using Windows and Linux builds, only ports 1026-60000 are valid. + // For fleets using Linux builds, only ports 22 and 1026-60000 are valid. + // + // For fleets using Windows builds, only ports 1026-60000 are valid. // // FromPort is a required field FromPort *int64 `min:"1" type:"integer" required:"true"` @@ -24769,9 +24759,11 @@ type IpPermission struct { Protocol *string `type:"string" required:"true" enum:"IpProtocol"` // An ending value for a range of allowed port numbers. Port numbers are end-inclusive. - // This value must be higher than FromPort. + // This value must be equal to or greater than FromPort. + // + // For fleets using Linux builds, only ports 22 and 1026-60000 are valid. // - // For fleets using Windows and Linux builds, only ports 1026-60000 are valid. + // For fleets using Windows builds, only ports 1026-60000 are valid. // // ToPort is a required field ToPort *int64 `min:"1" type:"integer" required:"true"` @@ -24847,7 +24839,7 @@ func (s *IpPermission) SetToPort(v int64) *IpPermission { return s } -// This data type is used with the GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server groups. // // An Amazon Elastic Compute Cloud launch template that contains configuration // settings and game server code to be deployed to all instances in a game server @@ -25132,7 +25124,7 @@ type ListBuildsInput struct { // 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. + // start at the beginning of the result set, don't specify a value. NextToken *string `min:"1" type:"string"` // Build status to filter results by. To retrieve all builds, leave this parameter @@ -25848,7 +25840,7 @@ type ListScriptsInput struct { // 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. + // start at the beginning of the result set, don't specify a value. NextToken *string `min:"1" type:"string"` } @@ -25944,10 +25936,10 @@ type ListTagsForResourceInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to and uniquely identifies the GameLift resource that you - // want to retrieve tags for. GameLift resource ARNs are included in the data - // object for the resource, which can be retrieved by calling a List or Describe - // operation for the resource type. + // that uniquely identifies the Amazon GameLift resource that you want to retrieve + // tags for. Amazon GameLift includes resource ARNs in the data object for the + // resource. You can retrieve the ARN by calling a List or Describe operation + // for the resource type. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` @@ -25996,7 +25988,7 @@ func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // The collection of tags that have been assigned to the specified resource. + // The collection of tags assigned to the resource. Tags []*Tag `type:"list"` } @@ -26076,7 +26068,7 @@ func (s *LocationAttributes) SetUpdateStatus(v string) *LocationAttributes { return s } -// A remote location where a multi-location fleet can deploy EC2 instances for +// A remote location where a multi-location fleet can deploy game servers for // game hosting. type LocationConfiguration struct { _ struct{} `type:"structure"` @@ -26132,7 +26124,7 @@ type LocationModel struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift location resource and uniquely identifies + // that is assigned to a Amazon GameLift location resource and uniquely identifies // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. LocationArn *string `min:"1" type:"string"` @@ -26179,9 +26171,9 @@ func (s *LocationModel) SetLocationName(v string) *LocationModel { // - NEW -- A new fleet location has been defined and desired instances is // set to 1. // -// - DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up -// the new fleet location, creating new instances with the game build or -// Realtime script and starting server processes. +// - DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting +// up the new fleet location, creating new instances with the game build +// or Realtime script and starting server processes. // // - ACTIVE -- Hosts can now accept game sessions. // @@ -26313,10 +26305,11 @@ type MatchmakingConfiguration struct { BackfillMode *string `type:"string" enum:"BackfillMode"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift matchmaking configuration resource and uniquely - // identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::matchmakingconfiguration/. In a GameLift configuration ARN, the resource ID matches - // the Name value. + // that is assigned to a Amazon GameLift matchmaking configuration resource + // and uniquely identifies it. ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::matchmakingconfiguration/. In a Amazon GameLift configuration ARN, the resource ID matches the + // Name value. ConfigurationArn *string `type:"string"` // A time stamp indicating when this data object was created. Format is a number @@ -26329,14 +26322,14 @@ type MatchmakingConfiguration struct { // A descriptive label that is associated with matchmaking configuration. Description *string `min:"1" type:"string"` - // Indicates whether this matchmaking configuration is being used with GameLift - // hosting or as a standalone matchmaking solution. + // Indicates whether this matchmaking configuration is being used with Amazon + // GameLift hosting or as a standalone matchmaking solution. // // * STANDALONE - FlexMatch forms matches and returns match information, // including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) // event. // - // * WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift + // * WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift // queue to start a game session for the match. FlexMatchMode *string `type:"string" enum:"FlexMatchMode"` @@ -26357,11 +26350,12 @@ type MatchmakingConfiguration struct { GameSessionData *string `min:"1" type:"string"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift game session queue resource and uniquely identifies - // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/::gamesessionqueue/. Queues can be located in any Region. Queues are used to start new - // GameLift-hosted game sessions for matches that are created with this matchmaking - // configuration. This property is not set when FlexMatchMode is set to STANDALONE. + // Amazon GameLift-hosted game sessions for matches that are created with this + // matchmaking configuration. This property is not set when FlexMatchMode is + // set to STANDALONE. GameSessionQueueArns []*string `type:"list"` // A unique identifier for the matchmaking configuration. This name is used @@ -26547,7 +26541,7 @@ type MatchmakingRuleSet struct { CreationTime *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift matchmaking rule set resource and uniquely + // that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely // identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::matchmakingruleset/. In a GameLift rule set ARN, the resource ID matches the RuleSetName // value. @@ -27214,12 +27208,12 @@ type PlayerSession struct { // to. GameSessionId *string `min:"1" type:"string"` - // The IP address of the game session. To connect to a GameLift game server, - // an app needs both the IP address and port number. + // The IP address of the game session. To connect to a Amazon GameLift game + // server, an app needs both the IP address and port number. IpAddress *string `min:"1" type:"string"` - // Developer-defined information related to a player. GameLift does not use - // this data, so it can be formatted as needed for use in the game. + // Developer-defined information related to a player. Amazon GameLift does not + // use this data, so it can be formatted as needed for use in the game. PlayerData *string `min:"1" type:"string"` // A unique identifier for a player that is associated with this player session. @@ -27674,7 +27668,7 @@ type RegisterComputeInput struct { _ struct{} `type:"structure"` // The path to the TLS certificate on your compute resource. The path and certificate - // are not validated by GameLift. + // are not validated by Amazon GameLift. CertificatePath *string `min:"1" type:"string"` // A descriptive label that is associated with the compute resource registered @@ -27683,8 +27677,8 @@ type RegisterComputeInput struct { // ComputeName is a required field ComputeName *string `min:"1" type:"string" required:"true"` - // The DNS name of the compute resource. GameLift requires the DNS name or IP - // address to manage your compute resource. + // The DNS name of the compute resource. Amazon GameLift requires the DNS name + // or IP address to manage your compute resource. DnsName *string `min:"1" type:"string"` // A unique identifier for the fleet to register the compute to. You can use @@ -27693,8 +27687,8 @@ type RegisterComputeInput struct { // FleetId is a required field FleetId *string `type:"string" required:"true"` - // The IP address of the compute resource. GameLift requires the DNS name or - // IP address to manage your compute resource. + // The IP address of the compute resource. Amazon GameLift requires the DNS + // name or IP address to manage your compute resource. IpAddress *string `min:"1" type:"string"` // The name of the custom location you added to the fleet you are registering @@ -28149,9 +28143,9 @@ func (s *ResolveAliasOutput) SetFleetId(v string) *ResolveAliasOutput { // players' ability to consume available resources. // // The policy is evaluated when a player tries to create a new game session. -// On receiving a CreateGameSession request, GameLift checks that the player -// (identified by CreatorId) has created fewer than game session limit in the -// specified time period. +// On receiving a CreateGameSession request, Amazon GameLift checks that the +// player (identified by CreatorId) has created fewer than game session limit +// in the specified time period. type ResourceCreationLimitPolicy struct { _ struct{} `type:"structure"` @@ -28160,9 +28154,9 @@ type ResourceCreationLimitPolicy struct { // players' ability to consume available resources. // // The policy is evaluated when a player tries to create a new game session. - // On receiving a CreateGameSession request, GameLift checks that the player - // (identified by CreatorId) has created fewer than game session limit in the - // specified time period. + // On receiving a CreateGameSession request, Amazon GameLift checks that the + // player (identified by CreatorId) has created fewer than game session limit + // in the specified time period. NewGameSessionsPerCreator *int64 `type:"integer"` // The time span used in evaluating the resource creation limit policy. @@ -28364,14 +28358,14 @@ func (s *RoutingStrategy) SetType(v string) *RoutingStrategy { // A collection of server process configurations that describe the set of processes // to run on each instance in a fleet. Server processes run either an executable -// in a custom game build or a Realtime Servers script. GameLift launches the -// configured processes, manages their life cycle, and replaces them as needed. -// Each instance checks regularly for an updated runtime configuration. -// -// A GameLift instance is limited to 50 processes running concurrently. To calculate -// the total number of processes in a runtime configuration, add the values -// of the ConcurrentExecutions parameter for each server process. Learn more -// about Running Multiple Processes on a Fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html). +// in a custom game build or a Realtime Servers script. Amazon GameLift launches +// the configured processes, manages their life cycle, and replaces them as +// needed. Each instance checks regularly for an updated runtime configuration. +// +// A Amazon GameLift instance is limited to 50 processes running concurrently. +// To calculate the total number of processes in a runtime configuration, add +// the values of the ConcurrentExecutions parameter for each server process. +// Learn more about Running Multiple Processes on a Fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html). type RuntimeConfiguration struct { _ struct{} `type:"structure"` @@ -28463,8 +28457,8 @@ type S3Location struct { // An Amazon S3 bucket identifier. Thename of the S3 bucket. // - // GameLift doesn't support uploading from Amazon S3 buckets with names that - // contain a dot (.). + // Amazon GameLift doesn't support uploading from Amazon S3 buckets with names + // that contain a dot (.). Bucket *string `min:"1" type:"string"` // The name of the zip file that contains the build files or script files. @@ -28559,8 +28553,8 @@ type ScalingPolicy struct { EvaluationPeriods *int64 `min:"1" type:"integer"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that is associated with this scaling policy. @@ -28782,13 +28776,13 @@ type Script struct { // expressed in Unix time as milliseconds (for example "1469498468.057"). CreationTime *time.Time `type:"timestamp"` - // A descriptive label that is associated with a script. Script names do not + // A descriptive label that is associated with a script. Script names don't // need to be unique. Name *string `min:"1" type:"string"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift script resource and uniquely identifies it. - // ARNs are unique across all Regions. In a GameLift script ARN, the resource + // that is assigned to a Amazon GameLift script resource and uniquely identifies + // it. ARNs are unique across all Regions. In a GameLift script ARN, the resource // ID matches the ScriptId value. ScriptArn *string `type:"string"` @@ -28809,8 +28803,8 @@ type Script struct { // an earlier version. StorageLocation *S3Location `type:"structure"` - // Version information associated with a build or script. Version strings do - // not need to be unique. + // Version information associated with a build or script. Version strings don't + // need to be unique. Version *string `min:"1" type:"string"` } @@ -29258,8 +29252,8 @@ type StartFleetActionsOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet to restart actions on. @@ -29854,8 +29848,8 @@ type StopFleetActionsOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet to stop actions on. @@ -30140,7 +30134,7 @@ func (s *SuspendGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *S return s } -// A label that can be assigned to a GameLift resource. +// A label that you can assign to a Amazon GameLift resource. // // # Learn more // @@ -30155,13 +30149,13 @@ func (s *SuspendGameServerGroupOutput) SetGameServerGroup(v *GameServerGroup) *S type Tag struct { _ struct{} `type:"structure"` - // The key for a developer-defined key:value pair for tagging an Amazon Web + // The key for a developer-defined key value pair for tagging an Amazon Web // Services resource. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` - // The value for a developer-defined key:value pair for tagging an Amazon Web + // The value for a developer-defined key value pair for tagging an Amazon Web // Services resource. // // Value is a required field @@ -30221,19 +30215,19 @@ type TagResourceInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to and uniquely identifies the GameLift resource that you - // want to assign tags to. GameLift resource ARNs are included in the data object - // for the resource, which can be retrieved by calling a List or Describe operation + // that uniquely identifies the Amazon GameLift resource that you want to assign + // tags to. Amazon GameLift includes resource ARNs in the data object for the + // resource. You can retrieve the ARN by calling a List or Describe operation // for the resource type. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` - // A list of one or more tags to assign to the specified GameLift resource. + // A list of one or more tags to assign to the specified Amazon GameLift resource. // Tags are developer-defined and structured as key-value pairs. The maximum // tag limit may be lower than stated. See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for actual - // tagging limits. + // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for tagging + // limits. // // Tags is a required field Tags []*Tag `type:"list" required:"true"` @@ -30441,14 +30435,15 @@ func (s *TargetConfiguration) SetTargetValue(v float64) *TargetConfiguration { return s } -// This data type is used with the GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server groups. // // Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerGroupAutoScalingPolicy.html) // . These settings are used to create a target-based policy that tracks the -// GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target -// value for the metric. As player usage changes, the policy triggers to adjust -// the game server group capacity so that the metric returns to the target value. +// Amazon GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies +// a target value for the metric. As player usage changes, the policy triggers +// to adjust the game server group capacity so that the metric returns to the +// target value. type TargetTrackingConfiguration struct { _ struct{} `type:"structure"` @@ -30695,17 +30690,16 @@ type UntagResourceInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to and uniquely identifies the GameLift resource that you - // want to remove tags from. GameLift resource ARNs are included in the data - // object for the resource, which can be retrieved by calling a List or Describe - // operation for the resource type. + // that uniquely identifies the Amazon GameLift resource that you want to remove + // tags from. Amazon GameLift includes resource ARNs in the data object for + // the resource. You can retrieve the ARN by calling a List or Describe operation + // for the resource type. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` - // A list of one or more tag keys to remove from the specified GameLift resource. - // An Amazon Web Services resource can have only one tag with a specific tag - // key, so specifying the tag key identifies which tag to remove. + // A list of one or more tag keys to remove from the specified Amazon GameLift + // resource. // // TagKeys is a required field TagKeys []*string `type:"list" required:"true"` @@ -30904,12 +30898,12 @@ type UpdateBuildInput struct { // BuildId is a required field BuildId *string `type:"string" required:"true"` - // A descriptive label associated with a build. Build names do not need to be + // A descriptive label associated with a build. Build names don't need to be // unique. Name *string `min:"1" type:"string"` - // Version information associated with a build or script. Version strings do - // not need to be unique. + // Version information associated with a build or script. Version strings don't + // need to be unique. Version *string `min:"1" type:"string"` } @@ -31002,7 +30996,7 @@ func (s *UpdateBuildOutput) SetBuild(v *Build) *UpdateBuildOutput { type UpdateFleetAttributesInput struct { _ struct{} `type:"structure"` - // GameLift Anywhere configuration options. + // Amazon GameLift Anywhere configuration options. AnywhereConfiguration *AnywhereConfiguration `type:"structure"` // A human-readable description of a fleet. @@ -31128,8 +31122,8 @@ type UpdateFleetAttributesOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that was updated. @@ -31261,8 +31255,8 @@ type UpdateFleetCapacityOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that was updated. @@ -31398,8 +31392,8 @@ type UpdateFleetPortSettingsOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift fleet resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // that is assigned to a Amazon GameLift fleet resource and uniquely identifies + // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. FleetArn *string `type:"string"` // A unique identifier for the fleet that was updated. @@ -31439,8 +31433,9 @@ func (s *UpdateFleetPortSettingsOutput) SetFleetId(v string) *UpdateFleetPortSet type UpdateGameServerGroupInput struct { _ struct{} `type:"structure"` - // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand - // Instances in the game server group. Method options include the following: + // Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances + // and On-Demand Instances in the game server group. Method options include + // the following: // // * SPOT_ONLY - Only Spot Instances are used in the game server group. If // Spot Instances are unavailable or not viable for game hosting, the game @@ -31478,9 +31473,9 @@ type UpdateGameServerGroupInput struct { // An updated list of Amazon EC2 instance types to use in the Auto Scaling group. // The instance definitions must specify at least two different instance types - // that are supported by GameLift FleetIQ. This updated list replaces the entire - // current list of instance definitions for the game server group. For more - // information on instance types, see EC2 Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // that are supported by Amazon GameLift FleetIQ. This updated list replaces + // the entire current list of instance definitions for the game server group. + // For more information on instance types, see EC2 Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) // in the Amazon EC2 User Guide. You can optionally specify capacity weighting // for each instance type. If no weight value is specified for an instance type, // it is set to the default value "1". For more information about capacity weighting, @@ -32082,14 +32077,14 @@ type UpdateMatchmakingConfigurationInput struct { // A description for the matchmaking configuration. Description *string `min:"1" type:"string"` - // Indicates whether this matchmaking configuration is being used with GameLift - // hosting or as a standalone matchmaking solution. + // Indicates whether this matchmaking configuration is being used with Amazon + // GameLift hosting or as a standalone matchmaking solution. // // * STANDALONE - FlexMatch forms matches and returns match information, // including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) // event. // - // * WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift + // * WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift // queue to start a game session for the match. FlexMatchMode *string `type:"string" enum:"FlexMatchMode"` @@ -32109,11 +32104,12 @@ type UpdateMatchmakingConfigurationInput struct { GameSessionData *string `min:"1" type:"string"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift game session queue resource and uniquely identifies - // it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/::gamesessionqueue/. Queues can be located in any Region. Queues are used to start new - // GameLift-hosted game sessions for matches that are created with this matchmaking - // configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter. + // Amazon GameLift-hosted game sessions for matches that are created with this + // matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not + // set this parameter. GameSessionQueueArns []*string `type:"list"` // A unique identifier for the matchmaking configuration to update. You can @@ -32321,7 +32317,7 @@ type UpdateRuntimeConfigurationInput struct { // FleetId is a required field FleetId *string `type:"string" required:"true"` - // Instructions for alaunching server processes on each instance in the fleet. + // Instructions for launching server processes on each instance in the fleet. // Server processes run either a custom game build executable or a Realtime // Servers script. The runtime configuration lists the types of server processes // to run on an instance, how to launch them, and the number of processes to @@ -32417,7 +32413,7 @@ func (s *UpdateRuntimeConfigurationOutput) SetRuntimeConfiguration(v *RuntimeCon type UpdateScriptInput struct { _ struct{} `type:"structure"` - // A descriptive label that is associated with a script. Script names do not + // A descriptive label that is associated with a script. Script names don't // need to be unique. Name *string `min:"1" type:"string"` @@ -32437,8 +32433,8 @@ type UpdateScriptInput struct { // an earlier version. StorageLocation *S3Location `type:"structure"` - // Version information associated with a build or script. Version strings do - // not need to be unique. + // Version information associated with a build or script. Version strings don't + // need to be unique. Version *string `min:"1" type:"string"` // A data object containing your Realtime scripts and dependencies as a zip @@ -32661,18 +32657,18 @@ type VpcPeeringAuthorization struct { ExpirationTime *time.Time `type:"timestamp"` // A unique identifier for the Amazon Web Services account that you use to manage - // your GameLift fleet. You can find your Account ID in the Amazon Web Services - // Management Console under account settings. + // your Amazon GameLift fleet. You can find your Account ID in the Amazon Web + // Services Management Console under account settings. GameLiftAwsAccountId *string `min:"1" type:"string"` // The authorization's peer VPC Amazon Web Services account ID. PeerVpcAwsAccountId *string `min:"1" type:"string"` - // A unique identifier for a VPC with resources to be accessed by your GameLift - // fleet. The VPC must be in the same Region as your fleet. To look up a VPC - // ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon - // Web Services Management Console. Learn more about VPC peering in VPC Peering - // with GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // A unique identifier for a VPC with resources to be accessed by your Amazon + // GameLift fleet. The VPC must be in the same Region as your fleet. To look + // up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) + // in the Amazon Web Services Management Console. Learn more about VPC peering + // in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). PeerVpcId *string `min:"1" type:"string"` } @@ -32753,11 +32749,11 @@ type VpcPeeringConnection struct { // it; these blocks cannot overlap or the peering connection cannot be created. IpV4CidrBlock *string `min:"1" type:"string"` - // A unique identifier for a VPC with resources to be accessed by your GameLift - // fleet. The VPC must be in the same Region as your fleet. To look up a VPC - // ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon - // Web Services Management Console. Learn more about VPC peering in VPC Peering - // with GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // A unique identifier for a VPC with resources to be accessed by your Amazon + // GameLift fleet. The VPC must be in the same Region as your fleet. To look + // up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) + // in the Amazon Web Services Management Console. Learn more about VPC peering + // in VPC Peering with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). PeerVpcId *string `min:"1" type:"string"` // The status information about the connection. Status indicates if a connection @@ -34462,6 +34458,9 @@ const ( // OperatingSystemAmazonLinux2 is a OperatingSystem enum value OperatingSystemAmazonLinux2 = "AMAZON_LINUX_2" + + // OperatingSystemWindows2016 is a OperatingSystem enum value + OperatingSystemWindows2016 = "WINDOWS_2016" ) // OperatingSystem_Values returns all elements of the OperatingSystem enum @@ -34470,6 +34469,7 @@ func OperatingSystem_Values() []string { OperatingSystemWindows2012, OperatingSystemAmazonLinux, OperatingSystemAmazonLinux2, + OperatingSystemWindows2016, } } diff --git a/service/gamelift/doc.go b/service/gamelift/doc.go index ab8ded7eb4..890f88a6d2 100644 --- a/service/gamelift/doc.go +++ b/service/gamelift/doc.go @@ -9,33 +9,35 @@ // GameLift helps you deliver high-performance, high-reliability, low-cost game // servers while dynamically scaling your resource usage to meet player demand. // -// # About GameLift solutions -// -// Get more information on these GameLift solutions in the GameLift Developer -// Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/). -// -// - GameLift managed hosting -- GameLift offers a fully managed service -// to set up and maintain computing machines for hosting, manage game session -// and player session life cycle, and handle security, storage, and performance -// tracking. You can use automatic scaling tools to balance player demand -// and hosting costs, configure your game session management to minimize -// player latency, and add FlexMatch for matchmaking. -// -// - Managed hosting with Realtime Servers -- With GameLift Realtime Servers, -// you can quickly configure and set up ready-to-go game servers for your -// game. Realtime Servers provides a game server framework with core GameLift -// infrastructure already built in. Then use the full range of GameLift managed -// hosting features, including FlexMatch, for your game. -// -// - GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while -// hosting your games using EC2 instances and Auto Scaling groups. GameLift -// FleetIQ provides optimizations for game hosting, including boosting the -// viability of low-cost Spot Instances gaming. For a complete solution, -// pair the GameLift FleetIQ and FlexMatch standalone services. -// -// - GameLift FlexMatch -- Add matchmaking to your game hosting solution. +// # About Amazon GameLift solutions +// +// Get more information on these Amazon GameLift solutions in the Amazon GameLift +// Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/). +// +// - Amazon GameLift managed hosting -- Amazon GameLift offers a fully managed +// service to set up and maintain computing machines for hosting, manage +// game session and player session life cycle, and handle security, storage, +// and performance tracking. You can use automatic scaling tools to balance +// player demand and hosting costs, configure your game session management +// to minimize player latency, and add FlexMatch for matchmaking. +// +// - Managed hosting with Realtime Servers -- With Amazon GameLift Realtime +// Servers, you can quickly configure and set up ready-to-go game servers +// for your game. Realtime Servers provides a game server framework with +// core Amazon GameLift infrastructure already built in. Then use the full +// range of Amazon GameLift managed hosting features, including FlexMatch, +// for your game. +// +// - Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone +// service while hosting your games using EC2 instances and Auto Scaling +// groups. Amazon GameLift FleetIQ provides optimizations for game hosting, +// including boosting the viability of low-cost Spot Instances gaming. For +// a complete solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone +// services. +// +// - Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. // FlexMatch is a customizable matchmaking service for multiplayer games. -// Use FlexMatch as integrated with GameLift managed hosting or incorporate +// Use FlexMatch as integrated with Amazon GameLift managed hosting or incorporate // FlexMatch as a standalone service into your own hosting solution. // // # About this API Reference @@ -44,9 +46,9 @@ // With each topic in this guide, you can find links to language-specific SDK // guides and the Amazon Web Services CLI reference. Useful links: // -// - GameLift API operations listed by tasks (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html) +// - Amazon GameLift API operations listed by tasks (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html) // -// - GameLift tools and resources (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html) +// - Amazon GameLift tools and resources (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html) // // See https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01 for more information on this service. // diff --git a/service/guardduty/api.go b/service/guardduty/api.go index 567b498c7d..677dde95a5 100644 --- a/service/guardduty/api.go +++ b/service/guardduty/api.go @@ -15335,6 +15335,113 @@ func (s *KubernetesWorkloadDetails) SetVolumes(v []*Volume) *KubernetesWorkloadD return s } +// Information about the Lambda function involved in the finding. +type LambdaDetails struct { + _ struct{} `type:"structure"` + + // Description of the Lambda function. + Description *string `locationName:"description" type:"string"` + + // Amazon Resource Name (ARN) of the Lambda function. + FunctionArn *string `locationName:"functionArn" type:"string"` + + // Name of the Lambda function. + FunctionName *string `locationName:"functionName" type:"string"` + + // The version of the Lambda function. + FunctionVersion *string `locationName:"functionVersion" type:"string"` + + // The timestamp when the Lambda function was last modified. This field is in + // the UTC date string format (2023-03-22T19:37:20.168Z). + LastModifiedAt *time.Time `locationName:"lastModifiedAt" type:"timestamp"` + + // The revision ID of the Lambda function version. + RevisionId *string `locationName:"revisionId" type:"string"` + + // The execution role of the Lambda function. + Role *string `locationName:"role" type:"string"` + + // A list of tags attached to this resource, listed in the format of key:value + // pair. + Tags []*Tag `locationName:"tags" type:"list"` + + // Amazon Virtual Private Cloud configuration details associated with your Lambda + // function. + VpcConfig *VpcConfig `locationName:"vpcConfig" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaDetails) GoString() string { + return s.String() +} + +// SetDescription sets the Description field's value. +func (s *LambdaDetails) SetDescription(v string) *LambdaDetails { + s.Description = &v + return s +} + +// SetFunctionArn sets the FunctionArn field's value. +func (s *LambdaDetails) SetFunctionArn(v string) *LambdaDetails { + s.FunctionArn = &v + return s +} + +// SetFunctionName sets the FunctionName field's value. +func (s *LambdaDetails) SetFunctionName(v string) *LambdaDetails { + s.FunctionName = &v + return s +} + +// SetFunctionVersion sets the FunctionVersion field's value. +func (s *LambdaDetails) SetFunctionVersion(v string) *LambdaDetails { + s.FunctionVersion = &v + return s +} + +// SetLastModifiedAt sets the LastModifiedAt field's value. +func (s *LambdaDetails) SetLastModifiedAt(v time.Time) *LambdaDetails { + s.LastModifiedAt = &v + return s +} + +// SetRevisionId sets the RevisionId field's value. +func (s *LambdaDetails) SetRevisionId(v string) *LambdaDetails { + s.RevisionId = &v + return s +} + +// SetRole sets the Role field's value. +func (s *LambdaDetails) SetRole(v string) *LambdaDetails { + s.Role = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *LambdaDetails) SetTags(v []*Tag) *LambdaDetails { + s.Tags = v + return s +} + +// SetVpcConfig sets the VpcConfig field's value. +func (s *LambdaDetails) SetVpcConfig(v *VpcConfig) *LambdaDetails { + s.VpcConfig = v + return s +} + // Information about the runtime process details. type LineageObject struct { _ struct{} `type:"structure"` @@ -19295,6 +19402,9 @@ type Resource struct { // Details about the Kubernetes user and workload involved in a Kubernetes finding. KubernetesDetails *KubernetesDetails `locationName:"kubernetesDetails" type:"structure"` + // Contains information about the Lambda function that was involved in a finding. + LambdaDetails *LambdaDetails `locationName:"lambdaDetails" type:"structure"` + // Contains information about the database instance to which an anomalous login // attempt was made. RdsDbInstanceDetails *RdsDbInstanceDetails `locationName:"rdsDbInstanceDetails" type:"structure"` @@ -19370,6 +19480,12 @@ func (s *Resource) SetKubernetesDetails(v *KubernetesDetails) *Resource { return s } +// SetLambdaDetails sets the LambdaDetails field's value. +func (s *Resource) SetLambdaDetails(v *LambdaDetails) *Resource { + s.LambdaDetails = v + return s +} + // SetRdsDbInstanceDetails sets the RdsDbInstanceDetails field's value. func (s *Resource) SetRdsDbInstanceDetails(v *RdsDbInstanceDetails) *Resource { s.RdsDbInstanceDetails = v @@ -23184,6 +23300,57 @@ func (s *VolumeMount) SetName(v string) *VolumeMount { return s } +// Amazon Virtual Private Cloud configuration details associated with your Lambda +// function. +type VpcConfig struct { + _ struct{} `type:"structure"` + + // The identifier of the security group attached to the Lambda function. + SecurityGroups []*SecurityGroup `locationName:"securityGroups" type:"list"` + + // The identifiers of the subnets that are associated with your Lambda function. + SubnetIds []*string `locationName:"subnetIds" type:"list"` + + // The identifier of the Amazon Virtual Private Cloud. + VpcId *string `locationName:"vpcId" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VpcConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VpcConfig) GoString() string { + return s.String() +} + +// SetSecurityGroups sets the SecurityGroups field's value. +func (s *VpcConfig) SetSecurityGroups(v []*SecurityGroup) *VpcConfig { + s.SecurityGroups = v + return s +} + +// SetSubnetIds sets the SubnetIds field's value. +func (s *VpcConfig) SetSubnetIds(v []*string) *VpcConfig { + s.SubnetIds = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *VpcConfig) SetVpcId(v string) *VpcConfig { + s.VpcId = &v + return s +} + const ( // AdminStatusEnabled is a AdminStatus enum value AdminStatusEnabled = "ENABLED" @@ -23419,6 +23586,9 @@ const ( // DetectorFeatureEksRuntimeMonitoring is a DetectorFeature enum value DetectorFeatureEksRuntimeMonitoring = "EKS_RUNTIME_MONITORING" + + // DetectorFeatureLambdaNetworkLogs is a DetectorFeature enum value + DetectorFeatureLambdaNetworkLogs = "LAMBDA_NETWORK_LOGS" ) // DetectorFeature_Values returns all elements of the DetectorFeature enum @@ -23429,6 +23599,7 @@ func DetectorFeature_Values() []string { DetectorFeatureEbsMalwareProtection, DetectorFeatureRdsLoginEvents, DetectorFeatureEksRuntimeMonitoring, + DetectorFeatureLambdaNetworkLogs, } } @@ -23456,6 +23627,9 @@ const ( // DetectorFeatureResultEksRuntimeMonitoring is a DetectorFeatureResult enum value DetectorFeatureResultEksRuntimeMonitoring = "EKS_RUNTIME_MONITORING" + + // DetectorFeatureResultLambdaNetworkLogs is a DetectorFeatureResult enum value + DetectorFeatureResultLambdaNetworkLogs = "LAMBDA_NETWORK_LOGS" ) // DetectorFeatureResult_Values returns all elements of the DetectorFeatureResult enum @@ -23469,6 +23643,7 @@ func DetectorFeatureResult_Values() []string { DetectorFeatureResultEbsMalwareProtection, DetectorFeatureResultRdsLoginEvents, DetectorFeatureResultEksRuntimeMonitoring, + DetectorFeatureResultLambdaNetworkLogs, } } @@ -23620,6 +23795,9 @@ const ( // FreeTrialFeatureResultEksRuntimeMonitoring is a FreeTrialFeatureResult enum value FreeTrialFeatureResultEksRuntimeMonitoring = "EKS_RUNTIME_MONITORING" + + // FreeTrialFeatureResultLambdaNetworkLogs is a FreeTrialFeatureResult enum value + FreeTrialFeatureResultLambdaNetworkLogs = "LAMBDA_NETWORK_LOGS" ) // FreeTrialFeatureResult_Values returns all elements of the FreeTrialFeatureResult enum @@ -23633,6 +23811,7 @@ func FreeTrialFeatureResult_Values() []string { FreeTrialFeatureResultEbsMalwareProtection, FreeTrialFeatureResultRdsLoginEvents, FreeTrialFeatureResultEksRuntimeMonitoring, + FreeTrialFeatureResultLambdaNetworkLogs, } } @@ -23735,6 +23914,9 @@ const ( // OrgFeatureEksRuntimeMonitoring is a OrgFeature enum value OrgFeatureEksRuntimeMonitoring = "EKS_RUNTIME_MONITORING" + + // OrgFeatureLambdaNetworkLogs is a OrgFeature enum value + OrgFeatureLambdaNetworkLogs = "LAMBDA_NETWORK_LOGS" ) // OrgFeature_Values returns all elements of the OrgFeature enum @@ -23745,6 +23927,7 @@ func OrgFeature_Values() []string { OrgFeatureEbsMalwareProtection, OrgFeatureRdsLoginEvents, OrgFeatureEksRuntimeMonitoring, + OrgFeatureLambdaNetworkLogs, } } diff --git a/service/iot/api.go b/service/iot/api.go index 8ce733cde2..472e2910ef 100644 --- a/service/iot/api.go +++ b/service/iot/api.go @@ -15651,6 +15651,12 @@ func (c *IoT) ListManagedJobTemplatesRequest(input *ListManagedJobTemplatesInput Name: opListManagedJobTemplates, HTTPMethod: "GET", HTTPPath: "/managed-job-templates", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { @@ -15708,6 +15714,57 @@ func (c *IoT) ListManagedJobTemplatesWithContext(ctx aws.Context, input *ListMan return out, req.Send() } +// ListManagedJobTemplatesPages iterates over the pages of a ListManagedJobTemplates operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListManagedJobTemplates method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListManagedJobTemplates operation. +// pageNum := 0 +// err := client.ListManagedJobTemplatesPages(params, +// func(page *iot.ListManagedJobTemplatesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *IoT) ListManagedJobTemplatesPages(input *ListManagedJobTemplatesInput, fn func(*ListManagedJobTemplatesOutput, bool) bool) error { + return c.ListManagedJobTemplatesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListManagedJobTemplatesPagesWithContext same as ListManagedJobTemplatesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoT) ListManagedJobTemplatesPagesWithContext(ctx aws.Context, input *ListManagedJobTemplatesInput, fn func(*ListManagedJobTemplatesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListManagedJobTemplatesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListManagedJobTemplatesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListManagedJobTemplatesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListMetricValues = "ListMetricValues" // ListMetricValuesRequest generates a "aws/request.Request" representing the @@ -17330,6 +17387,12 @@ func (c *IoT) ListRelatedResourcesForAuditFindingRequest(input *ListRelatedResou Name: opListRelatedResourcesForAuditFinding, HTTPMethod: "GET", HTTPPath: "/audit/relatedResources", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { @@ -17412,6 +17475,57 @@ func (c *IoT) ListRelatedResourcesForAuditFindingWithContext(ctx aws.Context, in return out, req.Send() } +// ListRelatedResourcesForAuditFindingPages iterates over the pages of a ListRelatedResourcesForAuditFinding operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRelatedResourcesForAuditFinding method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListRelatedResourcesForAuditFinding operation. +// pageNum := 0 +// err := client.ListRelatedResourcesForAuditFindingPages(params, +// func(page *iot.ListRelatedResourcesForAuditFindingOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *IoT) ListRelatedResourcesForAuditFindingPages(input *ListRelatedResourcesForAuditFindingInput, fn func(*ListRelatedResourcesForAuditFindingOutput, bool) bool) error { + return c.ListRelatedResourcesForAuditFindingPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListRelatedResourcesForAuditFindingPagesWithContext same as ListRelatedResourcesForAuditFindingPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoT) ListRelatedResourcesForAuditFindingPagesWithContext(ctx aws.Context, input *ListRelatedResourcesForAuditFindingInput, fn func(*ListRelatedResourcesForAuditFindingOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRelatedResourcesForAuditFindingInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRelatedResourcesForAuditFindingRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRelatedResourcesForAuditFindingOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListRoleAliases = "ListRoleAliases" // ListRoleAliasesRequest generates a "aws/request.Request" representing the @@ -70105,6 +70219,12 @@ const ( // OTAUpdateStatusCreateFailed is a OTAUpdateStatus enum value OTAUpdateStatusCreateFailed = "CREATE_FAILED" + + // OTAUpdateStatusDeleteInProgress is a OTAUpdateStatus enum value + OTAUpdateStatusDeleteInProgress = "DELETE_IN_PROGRESS" + + // OTAUpdateStatusDeleteFailed is a OTAUpdateStatus enum value + OTAUpdateStatusDeleteFailed = "DELETE_FAILED" ) // OTAUpdateStatus_Values returns all elements of the OTAUpdateStatus enum @@ -70114,6 +70234,8 @@ func OTAUpdateStatus_Values() []string { OTAUpdateStatusCreateInProgress, OTAUpdateStatusCreateComplete, OTAUpdateStatusCreateFailed, + OTAUpdateStatusDeleteInProgress, + OTAUpdateStatusDeleteFailed, } } diff --git a/service/iot/iotiface/interface.go b/service/iot/iotiface/interface.go index 7ed590ffcc..ea7a945a4d 100644 --- a/service/iot/iotiface/interface.go +++ b/service/iot/iotiface/interface.go @@ -752,6 +752,9 @@ type IoTAPI interface { ListManagedJobTemplatesWithContext(aws.Context, *iot.ListManagedJobTemplatesInput, ...request.Option) (*iot.ListManagedJobTemplatesOutput, error) ListManagedJobTemplatesRequest(*iot.ListManagedJobTemplatesInput) (*request.Request, *iot.ListManagedJobTemplatesOutput) + ListManagedJobTemplatesPages(*iot.ListManagedJobTemplatesInput, func(*iot.ListManagedJobTemplatesOutput, bool) bool) error + ListManagedJobTemplatesPagesWithContext(aws.Context, *iot.ListManagedJobTemplatesInput, func(*iot.ListManagedJobTemplatesOutput, bool) bool, ...request.Option) error + ListMetricValues(*iot.ListMetricValuesInput) (*iot.ListMetricValuesOutput, error) ListMetricValuesWithContext(aws.Context, *iot.ListMetricValuesInput, ...request.Option) (*iot.ListMetricValuesOutput, error) ListMetricValuesRequest(*iot.ListMetricValuesInput) (*request.Request, *iot.ListMetricValuesOutput) @@ -830,6 +833,9 @@ type IoTAPI interface { ListRelatedResourcesForAuditFindingWithContext(aws.Context, *iot.ListRelatedResourcesForAuditFindingInput, ...request.Option) (*iot.ListRelatedResourcesForAuditFindingOutput, error) ListRelatedResourcesForAuditFindingRequest(*iot.ListRelatedResourcesForAuditFindingInput) (*request.Request, *iot.ListRelatedResourcesForAuditFindingOutput) + ListRelatedResourcesForAuditFindingPages(*iot.ListRelatedResourcesForAuditFindingInput, func(*iot.ListRelatedResourcesForAuditFindingOutput, bool) bool) error + ListRelatedResourcesForAuditFindingPagesWithContext(aws.Context, *iot.ListRelatedResourcesForAuditFindingInput, func(*iot.ListRelatedResourcesForAuditFindingOutput, bool) bool, ...request.Option) error + ListRoleAliases(*iot.ListRoleAliasesInput) (*iot.ListRoleAliasesOutput, error) ListRoleAliasesWithContext(aws.Context, *iot.ListRoleAliasesInput, ...request.Option) (*iot.ListRoleAliasesOutput, error) ListRoleAliasesRequest(*iot.ListRoleAliasesInput) (*request.Request, *iot.ListRoleAliasesOutput) diff --git a/service/iot/service.go b/service/iot/service.go index 275665f4e9..d98bea45fe 100644 --- a/service/iot/service.go +++ b/service/iot/service.go @@ -51,7 +51,7 @@ const ( func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoT { c := p.ClientConfig(EndpointsID, cfgs...) if c.SigningNameDerived || len(c.SigningName) == 0 { - c.SigningName = "execute-api" + c.SigningName = "iot" } return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName, c.ResolvedRegion) } diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index 0dd4146ce5..fcb9d66129 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -158,6 +158,7 @@ func (c *SageMaker) AddTagsRequest(input *AddTagsInput) (req *request.Request, o // associated with a hyperparameter tuning job are also added to all training // jobs that the hyperparameter tuning job launches, add the tags when you first // create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html) // // Tags that you add to a SageMaker Studio Domain or User Profile by calling // this API are also added to any Apps that the Domain or User Profile launches @@ -165,8 +166,8 @@ func (c *SageMaker) AddTagsRequest(input *AddTagsInput) (req *request.Request, o // launched before you called this API. To make sure that the tags associated // with a Domain or User Profile are also added to all Apps that the Domain // or User Profile launches, add the tags when you first create the Domain or -// User Profile by specifying them in the Tags parameter of CreateDomain or -// CreateUserProfile. +// User Profile by specifying them in the Tags parameter of CreateDomain (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) +// or CreateUserProfile (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -241,7 +242,8 @@ func (c *SageMaker) AssociateTrialComponentRequest(input *AssociateTrialComponen // // Associates a trial component with a trial. A trial component can be associated // with multiple trials. To disassociate a trial component from a trial, call -// the DisassociateTrialComponent API. +// the DisassociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html) +// API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1088,9 +1090,11 @@ func (c *SageMaker) CreateCompilationJobRequest(input *CreateCompilationJobInput // use and costs. The response body contains the CompilationJobArn for the compiled // job. // -// To stop a model compilation job, use StopCompilationJob. To get information -// about a particular model compilation job, use DescribeCompilationJob. To -// get information about multiple model compilation jobs, use ListCompilationJobs. +// To stop a model compilation job, use StopCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html). +// To get information about a particular model compilation job, use DescribeCompilationJob +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html). +// To get information about multiple model compilation jobs, use ListCompilationJobs +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1791,7 +1795,8 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // // Creates an endpoint using the endpoint configuration specified in the request. // SageMaker uses the endpoint to provision resources and deploy models. You -// create the endpoint configuration with the CreateEndpointConfig API. +// create the endpoint configuration with the CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) +// API. // // Use this API to deploy models using SageMaker hosting services. // @@ -1808,21 +1813,24 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // When it receives the request, SageMaker creates the endpoint, launches the // resources (ML compute instances), and deploys the model(s) on them. // -// When you call CreateEndpoint, a load call is made to DynamoDB to verify that -// your endpoint configuration exists. When you read data from a DynamoDB table -// supporting Eventually Consistent Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html), +// When you call CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html), +// a load call is made to DynamoDB to verify that your endpoint configuration +// exists. When you read data from a DynamoDB table supporting Eventually Consistent +// Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html), // the response might not reflect the results of a recently completed write // operation. The response might include some stale data. If the dependent entities // are not yet in DynamoDB, this causes a validation error. If you repeat your // read request after a short time, the response should return the latest data. // So retry logic is recommended to handle these possible issues. We also recommend -// that customers call DescribeEndpointConfig before calling CreateEndpoint +// that customers call DescribeEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html) +// before calling CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) // to minimize the potential impact of a DynamoDB eventually consistent read. // // When SageMaker receives the request, it sets the endpoint status to Creating. // After it creates the endpoint, it sets the status to InService. SageMaker // can then process incoming requests for inferences. To check the status of -// an endpoint, use the DescribeEndpoint API. +// an endpoint, use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) +// API. // // If any of the models hosted at this endpoint get model data from an Amazon // S3 location, SageMaker uses Amazon Web Services Security Token Service to @@ -1837,8 +1845,9 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // To add the IAM role policies for using this API operation, go to the IAM // console (https://console.aws.amazon.com/iam/), and choose Roles in the left // navigation pane. Search the IAM role that you want to grant access to use -// the CreateEndpoint and CreateEndpointConfig API operations, add the following -// policies to the role. +// the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) +// and CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) +// API operations, add the following policies to the role. // // - Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess // policy. @@ -1930,7 +1939,8 @@ func (c *SageMaker) CreateEndpointConfigRequest(input *CreateEndpointConfigInput // Creates an endpoint configuration that SageMaker hosting services uses to // deploy models. In the configuration, you identify one or more models, created // using the CreateModel API, to deploy and the resources that you want SageMaker -// to provision. Then you call the CreateEndpoint API. +// to provision. Then you call the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) +// API. // // Use this API if you want to use SageMaker hosting services to deploy models // into production. @@ -1946,15 +1956,17 @@ func (c *SageMaker) CreateEndpointConfigRequest(input *CreateEndpointConfigInput // 2 for model A and 1 for model B. SageMaker distributes two-thirds of the // traffic to Model A, and one-third to model B. // -// When you call CreateEndpoint, a load call is made to DynamoDB to verify that -// your endpoint configuration exists. When you read data from a DynamoDB table -// supporting Eventually Consistent Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html), +// When you call CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html), +// a load call is made to DynamoDB to verify that your endpoint configuration +// exists. When you read data from a DynamoDB table supporting Eventually Consistent +// Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html), // the response might not reflect the results of a recently completed write // operation. The response might include some stale data. If the dependent entities // are not yet in DynamoDB, this causes a validation error. If you repeat your // read request after a short time, the response should return the latest data. // So retry logic is recommended to handle these possible issues. We also recommend -// that customers call DescribeEndpointConfig before calling CreateEndpoint +// that customers call DescribeEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html) +// before calling CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) // to minimize the potential impact of a DynamoDB eventually consistent read. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2052,16 +2064,20 @@ func (c *SageMaker) CreateExperimentRequest(input *CreateExperimentInput) (req * // the logging APIs provided by the SDK. // // You can add tags to experiments, trials, trial components and then use the -// Search API to search for the tags. +// Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API to search for the tags. // // To add a description to an experiment, specify the optional Description parameter. // To add a description later, or to change the description, call the UpdateExperiment +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateExperiment.html) // API. // -// To get a list of all your experiments, call the ListExperiments API. To view -// an experiment's properties, call the DescribeExperiment API. To get a list -// of all the trials associated with an experiment, call the ListTrials API. -// To create a trial call the CreateTrial API. +// To get a list of all your experiments, call the ListExperiments (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListExperiments.html) +// API. To view an experiment's properties, call the DescribeExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html) +// API. To get a list of all the trials associated with an experiment, call +// the ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) +// API. To create a trial call the CreateTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrial.html) +// API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4259,9 +4275,10 @@ func (c *SageMaker) CreatePresignedNotebookInstanceUrlRequest(input *CreatePresi // that you want to have access to the notebook instance. For more information, // see Limit Access to a Notebook Instance by IP Address (https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter). // -// The URL that you get from a call to CreatePresignedNotebookInstanceUrl is -// valid only for 5 minutes. If you try to use the URL after the 5-minute limit -// expires, you are directed to the Amazon Web Services console sign-in page. +// The URL that you get from a call to CreatePresignedNotebookInstanceUrl (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html) +// is valid only for 5 minutes. If you try to use the URL after the 5-minute +// limit expires, you are directed to the Amazon Web Services console sign-in +// page. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4917,12 +4934,13 @@ func (c *SageMaker) CreateTrialRequest(input *CreateTrialInput) (req *request.Re // When you use the Amazon Web Services SDK for Python (Boto), you must use // the logging APIs provided by the SDK. // -// You can add tags to a trial and then use the Search API to search for the -// tags. +// You can add tags to a trial and then use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API to search for the tags. // -// To get a list of all your trials, call the ListTrials API. To view a trial's -// properties, call the DescribeTrial API. To create a trial component, call -// the CreateTrialComponent API. +// To get a list of all your trials, call the ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) +// API. To view a trial's properties, call the DescribeTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html) +// API. To create a trial component, call the CreateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) +// API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5017,8 +5035,8 @@ func (c *SageMaker) CreateTrialComponentRequest(input *CreateTrialComponentInput // When you use the Amazon Web Services SDK for Python (Boto), you must use // the logging APIs provided by the SDK. // -// You can add tags to a trial component and then use the Search API to search -// for the tags. +// You can add tags to a trial component and then use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API to search for the tags. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5193,8 +5211,9 @@ func (c *SageMaker) CreateWorkforceRequest(input *CreateWorkforceInput) (req *re // per Amazon Web Services account. // // If you want to create a new workforce in an Amazon Web Services Region where -// a workforce already exists, use the API operation to delete the existing -// workforce and then use CreateWorkforce to create a new workforce. +// a workforce already exists, use the DeleteWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html) +// API operation to delete the existing workforce and then use CreateWorkforce +// to create a new workforce. // // To create a private workforce using Amazon Cognito, you must specify a Cognito // user pool in CognitoConfig. You can also create an Amazon Cognito workforce @@ -6558,8 +6577,8 @@ func (c *SageMaker) DeleteExperimentRequest(input *DeleteExperimentInput) (req * // DeleteExperiment API operation for Amazon SageMaker Service. // // Deletes an SageMaker experiment. All trials associated with the experiment -// must be deleted first. Use the ListTrials API to get a list of the trials -// associated with the experiment. +// must be deleted first. Use the ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) +// API to get a list of the trials associated with the experiment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6979,8 +6998,9 @@ func (c *SageMaker) DeleteHumanTaskUiRequest(input *DeleteHumanTaskUiInput) (req // Use this operation to delete a human task user interface (worker task template). // // To see a list of human task user interfaces (work task templates) in your -// account, use . When you delete a worker task template, it no longer appears -// when you call ListHumanTaskUis. +// account, use ListHumanTaskUis (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html). +// When you delete a worker task template, it no longer appears when you call +// ListHumanTaskUis. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8597,8 +8617,8 @@ func (c *SageMaker) DeleteTrialRequest(input *DeleteTrialInput) (req *request.Re // DeleteTrial API operation for Amazon SageMaker Service. // // Deletes the specified trial. All trial components that make up the trial -// must be deleted first. Use the DescribeTrialComponent API to get the list -// of trial components. +// must be deleted first. Use the DescribeTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html) +// API to get the list of trial components. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8678,7 +8698,8 @@ func (c *SageMaker) DeleteTrialComponentRequest(input *DeleteTrialComponentInput // // Deletes the specified trial component. A trial component must be disassociated // from all trials before the trial component can be deleted. To disassociate -// a trial component from a trial, call the DisassociateTrialComponent API. +// a trial component from a trial, call the DisassociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html) +// API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8845,9 +8866,11 @@ func (c *SageMaker) DeleteWorkforceRequest(input *DeleteWorkforceInput) (req *re // // If you want to create a new workforce in an Amazon Web Services Region where // a workforce already exists, use this operation to delete the existing workforce -// and then use to create a new workforce. +// and then use CreateWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html) +// to create a new workforce. // // If a private workforce contains one or more work teams, you must use the +// DeleteWorkteam (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) // operation to delete all work teams before you delete the workforce. If you // try to delete a workforce that contains one or more work teams, you will // recieve a ResourceInUse error. @@ -9696,8 +9719,9 @@ func (c *SageMaker) DescribeCompilationJobRequest(input *DescribeCompilationJobI // // Returns information about a model compilation job. // -// To create a model compilation job, use CreateCompilationJob. To get information -// about multiple model compilation jobs, use ListCompilationJobs. +// To create a model compilation job, use CreateCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html). +// To get information about multiple model compilation jobs, use ListCompilationJobs +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13653,9 +13677,11 @@ func (c *SageMaker) DisassociateTrialComponentRequest(input *DisassociateTrialCo // the component is associated with. Before you can delete a component, you // must disassociate the component from all trials it is associated with. To // associate a trial component with a trial, call the AssociateTrialComponent +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html) // API. // // To get a list of the trials a component is associated with, use the Search +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) // API. Specify ExperimentTrialComponent for the Resource parameter. The list // appears in the response under Results.TrialComponent.Parents. // @@ -15609,8 +15635,9 @@ func (c *SageMaker) ListCompilationJobsRequest(input *ListCompilationJobsInput) // // Lists model compilation jobs that satisfy various filters. // -// To create a model compilation job, use CreateCompilationJob. To get information -// about a particular model compilation job you have created, use DescribeCompilationJob. +// To create a model compilation job, use CreateCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html). +// To get information about a particular model compilation job you have created, +// use DescribeCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -17672,8 +17699,8 @@ func (c *SageMaker) ListHyperParameterTuningJobsRequest(input *ListHyperParamete // ListHyperParameterTuningJobs API operation for Amazon SageMaker Service. // -// Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter -// tuning jobs launched in your account. +// Gets a list of HyperParameterTuningJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html) +// objects that describe the hyperparameter tuning jobs launched in your account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -20703,6 +20730,7 @@ func (c *SageMaker) ListNotebookInstanceLifecycleConfigsRequest(input *ListNoteb // ListNotebookInstanceLifecycleConfigs API operation for Amazon SageMaker Service. // // Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) // API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -22565,8 +22593,9 @@ func (c *SageMaker) ListTrainingJobsForHyperParameterTuningJobRequest(input *Lis // ListTrainingJobsForHyperParameterTuningJob API operation for Amazon SageMaker Service. // -// Gets a list of TrainingJobSummary objects that describe the training jobs -// that a hyperparameter tuning job launched. +// Gets a list of TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) +// objects that describe the training jobs that a hyperparameter tuning job +// launched. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -24765,9 +24794,8 @@ func (c *SageMaker) StopCompilationJobRequest(input *StopCompilationJobInput) (r // signal. // // When it receives a StopCompilationJob request, Amazon SageMaker changes the -// CompilationJobSummary$CompilationJobStatus of the job to Stopping. After -// Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus -// to Stopped. +// CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops +// the job, it sets the CompilationJobStatus to Stopped. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -26479,7 +26507,8 @@ func (c *SageMaker) UpdateEndpointRequest(input *UpdateEndpointInput) (req *requ // // When SageMaker receives the request, it sets the endpoint status to Updating. // After updating the endpoint, it sets the status to InService. To check the -// status of an endpoint, use the DescribeEndpoint API. +// status of an endpoint, use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) +// API. // // You must not delete an EndpointConfig in use by an endpoint that is live // or while the UpdateEndpoint or CreateEndpoint operations are being performed @@ -26570,7 +26599,8 @@ func (c *SageMaker) UpdateEndpointWeightsAndCapacitiesRequest(input *UpdateEndpo // endpoint, or capacity of one variant associated with an existing endpoint. // When it receives the request, SageMaker sets the endpoint status to Updating. // After updating the endpoint, it sets the status to InService. To check the -// status of an endpoint, use the DescribeEndpoint API. +// status of an endpoint, use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) +// API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -26971,7 +27001,9 @@ func (c *SageMaker) UpdateImageRequest(input *UpdateImageInput) (req *request.Re // UpdateImage API operation for Amazon SageMaker Service. // // Updates the properties of a SageMaker image. To change the image's tags, -// use the AddTags and DeleteTags APIs. +// use the AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html) +// and DeleteTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) +// APIs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -27137,7 +27169,7 @@ func (c *SageMaker) UpdateInferenceExperimentRequest(input *UpdateInferenceExper // // Updates an inference experiment that you created. The status of the inference // experiment has to be either Created, Running. For more information on the -// status of an inference experiment, see DescribeInferenceExperimentResponse$Status. +// status of an inference experiment, see DescribeInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -27633,6 +27665,7 @@ func (c *SageMaker) UpdateNotebookInstanceLifecycleConfigRequest(input *UpdateNo // UpdateNotebookInstanceLifecycleConfig API operation for Amazon SageMaker Service. // // Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) // API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -28387,11 +28420,14 @@ func (c *SageMaker) UpdateWorkforceRequest(input *UpdateWorkforceInput) (req *re // own OIDC IdP. // // You can only update your OIDC IdP configuration when there are no work teams -// associated with your workforce. You can delete work teams using the operation. +// associated with your workforce. You can delete work teams using the DeleteWorkteam +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) +// operation. // // After restricting access to a range of IP addresses or updating your OIDC // IdP configuration with this operation, you can view details about your update -// workforce using the operation. +// workforce using the DescribeWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html) +// operation. // // This operation only applies to private workforces. // @@ -29110,7 +29146,8 @@ func (s *Alarm) SetAlarmName(v string) *Alarm { return s } -// Specifies the training algorithm to use in a CreateTrainingJob request. +// Specifies the training algorithm to use in a CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) +// request. // // For more information about algorithms provided by SageMaker, see Algorithms // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). For information @@ -29157,7 +29194,7 @@ type AlgorithmSpecification struct { // Tensorflow (version >= 1.15) MXNet (version >= 1.6) PyTorch (version >= // 1.3) // - // * You specify at least one MetricDefinition + // * You specify at least one MetricDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html) EnableSageMakerMetricsTimeSeries *bool `type:"boolean"` // A list of metric definition objects. Each object specifies the metric name @@ -31110,6 +31147,9 @@ type AsyncInferenceNotificationConfig struct { ErrorTopic *string `type:"string"` // The Amazon SNS topics where you want the inference response to be included. + // + // The inference response is included only if the response size is less than + // or equal to 128 KB. IncludeInferenceResponseIn []*string `type:"list" enum:"AsyncNotificationTopicTypes"` // Amazon SNS topic to post a notification to when inference completes successfully. @@ -33879,11 +33919,14 @@ func (s *CandidateProperties) SetCandidateMetrics(v []*MetricDatum) *CandidatePr return s } -// The SageMaker Canvas app settings. +// The SageMaker Canvas application settings. type CanvasAppSettings struct { _ struct{} `type:"structure"` - // Time series forecast settings for the Canvas app. + // The model registry settings for the SageMaker Canvas application. + ModelRegisterSettings *ModelRegisterSettings `type:"structure"` + + // Time series forecast settings for the Canvas application. TimeSeriesForecastingSettings *TimeSeriesForecastingSettings `type:"structure"` } @@ -33908,6 +33951,11 @@ func (s CanvasAppSettings) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CanvasAppSettings) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CanvasAppSettings"} + if s.ModelRegisterSettings != nil { + if err := s.ModelRegisterSettings.Validate(); err != nil { + invalidParams.AddNested("ModelRegisterSettings", err.(request.ErrInvalidParams)) + } + } if s.TimeSeriesForecastingSettings != nil { if err := s.TimeSeriesForecastingSettings.Validate(); err != nil { invalidParams.AddNested("TimeSeriesForecastingSettings", err.(request.ErrInvalidParams)) @@ -33920,6 +33968,12 @@ func (s *CanvasAppSettings) Validate() error { return nil } +// SetModelRegisterSettings sets the ModelRegisterSettings field's value. +func (s *CanvasAppSettings) SetModelRegisterSettings(v *ModelRegisterSettings) *CanvasAppSettings { + s.ModelRegisterSettings = v + return s +} + // SetTimeSeriesForecastingSettings sets the TimeSeriesForecastingSettings field's value. func (s *CanvasAppSettings) SetTimeSeriesForecastingSettings(v *TimeSeriesForecastingSettings) *CanvasAppSettings { s.TimeSeriesForecastingSettings = v @@ -34306,12 +34360,12 @@ type Channel struct { // (Optional) The input mode to use for the data channel in a training job. // If you don't set a value for InputMode, SageMaker uses the value set for // TrainingInputMode. Use this parameter to override the TrainingInputMode setting - // in a AlgorithmSpecification request when you have a channel that needs a - // different input mode from the training job's general setting. To download - // the data from Amazon Simple Storage Service (Amazon S3) to the provisioned - // ML storage volume, and mount the directory to a Docker volume, use File input - // mode. To stream data directly from Amazon S3 to the container, choose Pipe - // input mode. + // in a AlgorithmSpecification (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html) + // request when you have a channel that needs a different input mode from the + // training job's general setting. To download the data from Amazon Simple Storage + // Service (Amazon S3) to the provisioned ML storage volume, and mount the directory + // to a Docker volume, use File input mode. To stream data directly from Amazon + // S3 to the container, choose Pipe input mode. // // To use a model for incremental training, choose File input model. InputMode *string `type:"string" enum:"TrainingInputMode"` @@ -37826,10 +37880,10 @@ type CreateCompilationJobInput struct { // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Tags []*Tag `type:"list"` - // A VpcConfig object that specifies the VPC that you want your compilation - // job to connect to. Control access to your models by configuring the VPC. - // For more information, see Protect Compilation Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). + // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that you want your compilation job to connect + // to. Control access to your models by configuring the VPC. For more information, + // see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). VpcConfig *NeoVpcConfig `type:"structure"` } @@ -39247,6 +39301,7 @@ type CreateEndpointConfigInput struct { DataCaptureConfig *DataCaptureConfig `type:"structure"` // The name of the endpoint configuration. You specify this name in a CreateEndpoint + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) // request. // // EndpointConfigName is a required field @@ -39482,14 +39537,16 @@ type CreateEndpointInput struct { // deployment strategy and rollback configurations. DeploymentConfig *DeploymentConfig `type:"structure"` - // The name of an endpoint configuration. For more information, see CreateEndpointConfig. + // The name of an endpoint configuration. For more information, see CreateEndpointConfig + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html). // // EndpointConfigName is a required field EndpointConfigName *string `type:"string" required:"true"` // The name of the endpoint.The name must be unique within an Amazon Web Services // Region in your Amazon Web Services account. The name is case-insensitive - // in CreateEndpoint, but the case is preserved and must be matched in . + // in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html). // // EndpointName is a required field EndpointName *string `type:"string" required:"true"` @@ -39623,8 +39680,8 @@ type CreateExperimentInput struct { // ExperimentName is a required field ExperimentName *string `min:"1" type:"string" required:"true"` - // A list of tags to associate with the experiment. You can use Search API to - // search on the tags. + // A list of tags to associate with the experiment. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) + // API to search on the tags. Tags []*Tag `type:"list"` } @@ -39795,14 +39852,16 @@ type CreateFeatureGroupInput struct { // * Format for the offline store table. Supported formats are Glue (Default) // and Apache Iceberg (https://iceberg.apache.org/). // - // To learn more about this parameter, see OfflineStoreConfig. + // To learn more about this parameter, see OfflineStoreConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html). OfflineStoreConfig *OfflineStoreConfig `type:"structure"` // You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore - // flag in OnlineStoreConfig; the default value is False. + // flag in OnlineStoreConfig. // // You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest // encryption of the OnlineStore. + // + // The default value is False. OnlineStoreConfig *OnlineStoreConfig `type:"structure"` // The name of the Feature whose value uniquely identifies a Record defined @@ -40453,10 +40512,11 @@ func (s *CreateHumanTaskUiOutput) SetHumanTaskUiArn(v string) *CreateHumanTaskUi type CreateHyperParameterTuningJobInput struct { _ struct{} `type:"structure"` - // The HyperParameterTuningJobConfig object that describes the tuning job, including - // the search strategy, the objective metric used to evaluate training jobs, - // ranges of parameters to search, and resource limits for the tuning job. For - // more information, see How Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). + // The HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) + // object that describes the tuning job, including the search strategy, the + // objective metric used to evaluate training jobs, ranges of parameters to + // search, and resource limits for the tuning job. For more information, see + // How Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). // // HyperParameterTuningJobConfig is a required field HyperParameterTuningJobConfig *HyperParameterTuningJobConfig `type:"structure" required:"true"` @@ -40479,14 +40539,14 @@ type CreateHyperParameterTuningJobInput struct { // that the tuning job launches. Tags []*Tag `type:"list"` - // The HyperParameterTrainingJobDefinition object that describes the training - // jobs that this tuning job launches, including static hyperparameters, input - // data configuration, output data configuration, resource configuration, and - // stopping condition. + // The HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) + // object that describes the training jobs that this tuning job launches, including + // static hyperparameters, input data configuration, output data configuration, + // resource configuration, and stopping condition. TrainingJobDefinition *HyperParameterTrainingJobDefinition `type:"structure"` - // A list of the HyperParameterTrainingJobDefinition objects launched for this - // tuning job. + // A list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) + // objects launched for this tuning job. TrainingJobDefinitions []*HyperParameterTrainingJobDefinition `min:"1" type:"list"` // Specifies the configuration for starting the hyperparameter tuning job using @@ -41308,7 +41368,11 @@ type CreateInferenceRecommendationsJobInput struct { JobDescription *string `type:"string"` // A name for the recommendation job. The name must be unique within the Amazon - // Web Services Region and within your Amazon Web Services account. + // Web Services Region and within your Amazon Web Services account. The job + // name is passed down to the resources created by the recommendation job. The + // names of resources (such as the model, endpoint configuration, endpoint, + // and compilation) that are prefixed with the job name are truncated at 40 + // characters. // // JobName is a required field JobName *string `min:"1" type:"string" required:"true"` @@ -42188,7 +42252,7 @@ type CreateModelCardInput struct { _ struct{} `type:"structure"` // The content of the model card. Content must be in model card JSON schema - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) + // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) // and provided as a string. // // Content is a sensitive parameter and its value will be @@ -42620,9 +42684,10 @@ type CreateModelInput struct { // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Tags []*Tag `type:"list"` - // A VpcConfig object that specifies the VPC that you want your model to connect - // to. Control access to and from your model container by configuring the VPC. - // VpcConfig is used in hosting services and in batch transform. For more information, + // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that you want your model to connect to. Control + // access to and from your model container by configuring the VPC. VpcConfig + // is used in hosting services and in batch transform. For more information, // see Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) // and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). @@ -44427,11 +44492,11 @@ type CreateProcessingJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // Networking options for a processing job, such as whether to allow inbound @@ -45132,11 +45197,11 @@ type CreateTrainingJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // Algorithm-specific parameters that influence the quality of the model. You @@ -45243,10 +45308,11 @@ type CreateTrainingJobInput struct { // TrainingJobName is a required field TrainingJobName *string `min:"1" type:"string" required:"true"` - // A VpcConfig object that specifies the VPC that you want your training job - // to connect to. Control access to and from your training container by configuring - // the VPC. For more information, see Protect Training Jobs by Using an Amazon - // Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that you want your training job to connect + // to. Control access to and from your training container by configuring the + // VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual + // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). VpcConfig *VpcConfig `type:"structure"` } @@ -45596,11 +45662,11 @@ type CreateTransformJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // The maximum number of parallel requests that can be sent to each instance @@ -45907,8 +45973,8 @@ type CreateTrialComponentInput struct { // * Failed Status *TrialComponentStatus `type:"structure"` - // A list of tags to associate with the component. You can use Search API to - // search on the tags. + // A list of tags to associate with the component. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) + // API to search on the tags. Tags []*Tag `type:"list"` // The name of the component. The name must be unique in your Amazon Web Services @@ -46091,8 +46157,8 @@ type CreateTrialInput struct { // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties *MetadataProperties `type:"structure"` - // A list of tags to associate with the trial. You can use Search API to search - // on the tags. + // A list of tags to associate with the trial. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) + // API to search on the tags. Tags []*Tag `type:"list"` // The name of the trial. The name must be unique in your Amazon Web Services @@ -47848,7 +47914,7 @@ func (s *DebugRuleEvaluationStatus) SetStatusDetails(v string) *DebugRuleEvaluat type DefaultSpaceSettings struct { _ struct{} `type:"structure"` - // The execution role for the space. + // The ARN of the execution role for the space. ExecutionRole *string `min:"20" type:"string"` // The JupyterServer app settings. @@ -47857,8 +47923,8 @@ type DefaultSpaceSettings struct { // The KernelGateway app settings. KernelGatewayAppSettings *KernelGatewayAppSettings `type:"structure"` - // The security groups for the Amazon Virtual Private Cloud that the space uses - // for communication. + // The security group IDs for the Amazon Virtual Private Cloud that the space + // uses for communication. SecurityGroups []*string `type:"list"` } @@ -51406,7 +51472,7 @@ func (s *DeleteWorkteamOutput) SetSuccess(v bool) *DeleteWorkteamOutput { } // Gets the Amazon EC2 Container Registry path of the docker image of the model -// that is hosted in this ProductionVariant. +// that is hosted in this ProductionVariant (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html). // // If you used the registry/repository[:tag] form to specify the image path // of the primary container when you created the model hosted in this ProductionVariant, @@ -53407,10 +53473,9 @@ type DescribeCompilationJobOutput struct { // The time when the model compilation job started the CompilationJob instances. // // You are billed for the time between this timestamp and the timestamp in the - // DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch - // Logs, the start time might be later than this time. That's because it takes - // time to download the compilation job, which depends on the size of the compilation - // job container. + // CompilationEndTime field. In Amazon CloudWatch Logs, the start time might + // be later than this time. That's because it takes time to download the compilation + // job, which depends on the size of the compilation job container. CompilationStartTime *time.Time `type:"timestamp"` // The time that the model compilation job was created. @@ -53472,10 +53537,10 @@ type DescribeCompilationJobOutput struct { // StoppingCondition is a required field StoppingCondition *StoppingCondition `type:"structure" required:"true"` - // A VpcConfig object that specifies the VPC that you want your compilation - // job to connect to. Control access to your models by configuring the VPC. - // For more information, see Protect Compilation Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). + // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that you want your compilation job to connect + // to. Control access to your models by configuring the VPC. For more information, + // see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). VpcConfig *NeoVpcConfig `type:"structure"` } @@ -55246,9 +55311,12 @@ type DescribeEndpointOutput struct { // // * OutOfService: Endpoint is not available to take incoming requests. // - // * Creating: CreateEndpoint is executing. + // * Creating: CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) + // is executing. // - // * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. + // * Updating: UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) + // or UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) + // is executing. // // * SystemUpdating: Endpoint is undergoing maintenance and cannot be updated // or deleted or re-scaled until it has completed. This maintenance operation @@ -55260,16 +55328,19 @@ type DescribeEndpointOutput struct { // Once the rollback completes, endpoint returns to an InService status. // This transitional status only applies to an endpoint that has autoscaling // enabled and is undergoing variant weight or capacity changes as part of - // an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities + // an UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) + // call or when the UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) // operation is called explicitly. // // * InService: Endpoint is available to process incoming requests. // - // * Deleting: DeleteEndpoint is executing. + // * Deleting: DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) + // is executing. // - // * Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason - // for information about the failure. DeleteEndpoint is the only operation - // that can be performed on a failed endpoint. + // * Failed: Endpoint could not be created, updated, or re-scaled. Use the + // FailureReason value returned by DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) + // for information about the failure. DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) + // is the only operation that can be performed on a failed endpoint. // // EndpointStatus is a required field EndpointStatus *string `type:"string" required:"true" enum:"EndpointStatus"` @@ -55292,13 +55363,13 @@ type DescribeEndpointOutput struct { // when the endpoint is creating or updating with a new endpoint configuration. PendingDeploymentSummary *PendingDeploymentSummary `type:"structure"` - // An array of ProductionVariantSummary objects, one for each model hosted behind - // this endpoint. + // An array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html) + // objects, one for each model hosted behind this endpoint. ProductionVariants []*ProductionVariantSummary `min:"1" type:"list"` - // An array of ProductionVariantSummary objects, one for each model that you - // want to host at this endpoint in shadow mode with production traffic replicated - // from the model specified on ProductionVariants. + // An array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html) + // objects, one for each model that you want to host at this endpoint in shadow + // mode with production traffic replicated from the model specified on ProductionVariants. ShadowProductionVariants []*ProductionVariantSummary `min:"1" type:"list"` } @@ -56803,8 +56874,9 @@ func (s *DescribeHyperParameterTuningJobInput) SetHyperParameterTuningJobName(v type DescribeHyperParameterTuningJobOutput struct { _ struct{} `type:"structure"` - // A TrainingJobSummary object that describes the training job that completed - // with the best current HyperParameterTuningJobObjective. + // A TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) + // object that describes the training job that completed with the best current + // HyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html). BestTrainingJob *HyperParameterTrainingJobSummary `type:"structure"` // The total resources consumed by your hyperparameter tuning job. @@ -56826,8 +56898,8 @@ type DescribeHyperParameterTuningJobOutput struct { // HyperParameterTuningJobArn is a required field HyperParameterTuningJobArn *string `type:"string" required:"true"` - // The HyperParameterTuningJobConfig object that specifies the configuration - // of the tuning job. + // The HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) + // object that specifies the configuration of the tuning job. // // HyperParameterTuningJobConfig is a required field HyperParameterTuningJobConfig *HyperParameterTuningJobConfig `type:"structure" required:"true"` @@ -56846,29 +56918,32 @@ type DescribeHyperParameterTuningJobOutput struct { // The date and time that the status of the tuning job was modified. LastModifiedTime *time.Time `type:"timestamp"` - // The ObjectiveStatusCounters object that specifies the number of training - // jobs, categorized by the status of their final objective metric, that this - // tuning job launched. + // The ObjectiveStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html) + // object that specifies the number of training jobs, categorized by the status + // of their final objective metric, that this tuning job launched. // // ObjectiveStatusCounters is a required field ObjectiveStatusCounters *ObjectiveStatusCounters `type:"structure" required:"true"` // If the hyperparameter tuning job is an warm start tuning job with a WarmStartType - // of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training - // job with the best objective metric value of all training jobs launched by - // this tuning job and all parent jobs specified for the warm start tuning job. + // of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) + // for the training job with the best objective metric value of all training + // jobs launched by this tuning job and all parent jobs specified for the warm + // start tuning job. OverallBestTrainingJob *HyperParameterTrainingJobSummary `type:"structure"` - // The HyperParameterTrainingJobDefinition object that specifies the definition - // of the training jobs that this tuning job launches. + // The HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) + // object that specifies the definition of the training jobs that this tuning + // job launches. TrainingJobDefinition *HyperParameterTrainingJobDefinition `type:"structure"` - // A list of the HyperParameterTrainingJobDefinition objects launched for this - // tuning job. + // A list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) + // objects launched for this tuning job. TrainingJobDefinitions []*HyperParameterTrainingJobDefinition `min:"1" type:"list"` - // The TrainingJobStatusCounters object that specifies the number of training - // jobs, categorized by status, that this tuning job launched. + // The TrainingJobStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html) + // object that specifies the number of training jobs, categorized by status, + // that this tuning job launched. // // TrainingJobStatusCounters is a required field TrainingJobStatusCounters *TrainingJobStatusCounters `type:"structure" required:"true"` @@ -57497,7 +57572,7 @@ type DescribeInferenceExperimentOutput struct { // The Amazon Web Services Key Management Service (Amazon Web Services KMS) // key that Amazon SageMaker uses to encrypt data on the storage volume attached // to the ML compute instance that hosts the endpoint. For more information, - // see CreateInferenceExperimentRequest$KmsKey. + // see CreateInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html). KmsKey *string `type:"string"` // The timestamp at which you last modified the inference experiment. @@ -57551,12 +57626,14 @@ type DescribeInferenceExperimentOutput struct { // * Completed - Your experiment has completed. // // * Cancelled - When you conclude your experiment early using the StopInferenceExperiment + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) // API, or if any operation fails with an unexpected error, it shows as cancelled. // // Status is a required field Status *string `type:"string" required:"true" enum:"InferenceExperimentStatus"` // The error message or client-specified Reason from the StopInferenceExperiment + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) // API, that explains the status of the inference experiment. StatusReason *string `type:"string"` @@ -59218,9 +59295,9 @@ type DescribeModelOutput struct { // environment map that the inference code uses when it is deployed in production. PrimaryContainer *ContainerDefinition `type:"structure"` - // A VpcConfig object that specifies the VPC that this model has access to. - // For more information, see Protect Endpoints by Using an Amazon Virtual Private - // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) + // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that this model has access to. For more information, + // see Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) VpcConfig *VpcConfig `type:"structure"` } @@ -61960,11 +62037,11 @@ type DescribeTrainingJobOutput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // If the training job failed, the reason it failed. @@ -62027,7 +62104,7 @@ type DescribeTrainingJobOutput struct { // Provides detailed information about the state of the training job. For detailed // information on the secondary status of the training job, see StatusMessage - // under SecondaryStatusTransition. + // under SecondaryStatusTransition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html). // // SageMaker provides primary statuses and secondary statuses that apply to // each of them: @@ -62156,9 +62233,10 @@ type DescribeTrainingJobOutput struct { // if the training job was launched by a hyperparameter tuning job. TuningJobArn *string `type:"string"` - // A VpcConfig object that specifies the VPC that this training job has access - // to. For more information, see Protect Training Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that this training job has access to. For more + // information, see Protect Training Jobs by Using an Amazon Virtual Private + // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). VpcConfig *VpcConfig `type:"structure"` // The status of the warm pool associated with the training job. @@ -62516,11 +62594,11 @@ type DescribeTransformJobOutput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // If the transform job failed, FailureReason describes why it failed. A transform @@ -66193,7 +66271,7 @@ type EndpointMetadata struct { EndpointName *string `type:"string" required:"true"` // The status of the endpoint. For possible values of the status of an endpoint, - // see EndpointSummary$EndpointStatus. + // see EndpointSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_EndpointSummary.html). EndpointStatus *string `type:"string" enum:"EndpointStatus"` // If the status of the endpoint is Failed, or the status is InService but update @@ -66382,9 +66460,12 @@ type EndpointSummary struct { // // * OutOfService: Endpoint is not available to take incoming requests. // - // * Creating: CreateEndpoint is executing. + // * Creating: CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) + // is executing. // - // * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. + // * Updating: UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) + // or UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) + // is executing. // // * SystemUpdating: Endpoint is undergoing maintenance and cannot be updated // or deleted or re-scaled until it has completed. This maintenance operation @@ -66396,19 +66477,21 @@ type EndpointSummary struct { // Once the rollback completes, endpoint returns to an InService status. // This transitional status only applies to an endpoint that has autoscaling // enabled and is undergoing variant weight or capacity changes as part of - // an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities + // an UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) + // call or when the UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) // operation is called explicitly. // // * InService: Endpoint is available to process incoming requests. // - // * Deleting: DeleteEndpoint is executing. + // * Deleting: DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) + // is executing. // // * Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason - // for information about the failure. DeleteEndpoint is the only operation - // that can be performed on a failed endpoint. + // for information about the failure. DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) + // is the only operation that can be performed on a failed endpoint. // - // To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals - // filter. + // To get a list of endpoints with a specified status, use the StatusEquals + // filter with a call to ListEndpoints (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html). // // EndpointStatus is a required field EndpointStatus *string `type:"string" required:"true" enum:"EndpointStatus"` @@ -66579,7 +66662,8 @@ func (s *EnvironmentParameterRanges) SetCategoricalParameterRanges(v []*Categori return s } -// The properties of an experiment as returned by the Search API. +// The properties of an experiment as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API. type Experiment struct { _ struct{} `type:"structure"` @@ -66613,6 +66697,7 @@ type Experiment struct { Source *ExperimentSource `type:"structure"` // The list of tags that are associated with the experiment. You can use Search + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) // API to search on the tags. Tags []*Tag `type:"list"` } @@ -66698,11 +66783,11 @@ func (s *Experiment) SetTags(v []*Tag) *Experiment { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // -// - CreateProcessingJob +// - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // -// - CreateTrainingJob +// - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // -// - CreateTransformJob +// - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) type ExperimentConfig struct { _ struct{} `type:"structure"` @@ -66829,7 +66914,8 @@ func (s *ExperimentSource) SetSourceType(v string) *ExperimentSource { } // A summary of the properties of an experiment. To get the complete set of -// properties, call the DescribeExperiment API and provide the ExperimentName. +// properties, call the DescribeExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html) +// API and provide the ExperimentName. type ExperimentSummary struct { _ struct{} `type:"structure"` @@ -67154,8 +67240,9 @@ type FeatureGroup struct { // Use this to specify the Amazon Web Services Key Management Service (KMS) // Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore - // on or off by specifying the EnableOnlineStore flag at General Assembly; the - // default value is False. + // on or off by specifying the EnableOnlineStore flag at General Assembly. + // + // The default value is False. OnlineStoreConfig *OnlineStoreConfig `type:"structure"` // The name of the Feature whose value uniquely identifies a Record defined @@ -67726,7 +67813,8 @@ func (s *FileSystemDataSource) SetFileSystemType(v string) *FileSystemDataSource // A conditional statement for a search expression that includes a resource // property, a Boolean operator, and a value. Resources that match the statement -// are returned in the results from the Search API. +// are returned in the results from the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API. // // If you specify a Value, but not an Operator, SageMaker uses the equals operator. // @@ -67774,7 +67862,8 @@ type Filter struct { _ struct{} `type:"structure"` // A resource property name. For example, TrainingJobName. For valid property - // names, see SearchRecord. You must specify a valid property for the resource. + // names, see SearchRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html). + // You must specify a valid property for the resource. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` @@ -67985,7 +68074,7 @@ func (s *FinalAutoMLJobObjectiveMetric) SetValue(v float64) *FinalAutoMLJobObjec // Shows the latest objective metric emitted by a training job that was launched // by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective -// parameter of HyperParameterTuningJobConfig. +// parameter of HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html). type FinalHyperParameterTuningJobObjectiveMetric struct { _ struct{} `type:"structure"` @@ -69078,7 +69167,9 @@ func (s *HubS3StorageConfig) SetS3OutputPath(v string) *HubS3StorageConfig { } // Defines under what conditions SageMaker creates a human loop. Used within -// . See for the required format of activation conditions. +// CreateFlowDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFlowDefinition.html). +// See HumanLoopActivationConditionsConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HumanLoopActivationConditionsConfig.html) +// for the required format of activation conditions. type HumanLoopActivationConditionsConfig struct { _ struct{} `type:"structure"` @@ -70546,8 +70637,8 @@ type HyperParameterAlgorithmSpecification struct { // If you specify a value for this parameter, do not specify a value for TrainingImage. AlgorithmName *string `min:"1" type:"string"` - // An array of MetricDefinition objects that specify the metrics that the algorithm - // emits. + // An array of MetricDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html) + // objects that specify the metrics that the algorithm emits. MetricDefinitions []*MetricDefinition `type:"list"` // The registry path of the Docker image that contains the training algorithm. @@ -70785,8 +70876,9 @@ func (s *HyperParameterSpecification) SetType(v string) *HyperParameterSpecifica type HyperParameterTrainingJobDefinition struct { _ struct{} `type:"structure"` - // The HyperParameterAlgorithmSpecification object that specifies the resource - // algorithm to use for the training jobs that the tuning job launches. + // The HyperParameterAlgorithmSpecification (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterAlgorithmSpecification.html) + // object that specifies the resource algorithm to use for the training jobs + // that the tuning job launches. // // AlgorithmSpecification is a required field AlgorithmSpecification *HyperParameterAlgorithmSpecification `type:"structure" required:"true"` @@ -70851,8 +70943,9 @@ type HyperParameterTrainingJobDefinition struct { // to additionally store training data in the storage volume (optional). HyperParameterTuningResourceConfig *HyperParameterTuningResourceConfig `type:"structure"` - // An array of Channel objects that specify the input for the training jobs - // that the tuning job launches. + // An array of Channel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html) + // objects that specify the input for the training jobs that the tuning job + // launches. InputDataConfig []*Channel `min:"1" type:"list"` // Specifies the path to the Amazon S3 bucket where you store model artifacts @@ -70901,10 +70994,11 @@ type HyperParameterTrainingJobDefinition struct { // value for this metric, depending on the value you specify for the Type parameter. TuningObjective *HyperParameterTuningJobObjective `type:"structure"` - // The VpcConfig object that specifies the VPC that you want the training jobs - // that this hyperparameter tuning job launches to connect to. Control access - // to and from your training container by configuring the VPC. For more information, - // see Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // The VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that you want the training jobs that this hyperparameter + // tuning job launches to connect to. Control access to and from your training + // container by configuring the VPC. For more information, see Protect Training + // Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). VpcConfig *VpcConfig `type:"structure"` } @@ -71137,9 +71231,9 @@ type HyperParameterTrainingJobSummary struct { // The reason that the training job failed. FailureReason *string `type:"string"` - // The FinalHyperParameterTuningJobObjectiveMetric object that specifies the - // value of the objective metric of the tuning job that launched this training - // job. + // The FinalHyperParameterTuningJobObjectiveMetric (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_FinalHyperParameterTuningJobObjectiveMetric.html) + // object that specifies the value of the objective metric of the tuning job + // that launched this training job. FinalHyperParameterTuningJobObjectiveMetric *FinalHyperParameterTuningJobObjectiveMetric `type:"structure"` // The status of the objective metric for the training job: @@ -71422,13 +71516,15 @@ func (s *HyperParameterTuningJobCompletionDetails) SetNumberOfTrainingJobsObject type HyperParameterTuningJobConfig struct { _ struct{} `type:"structure"` - // The HyperParameterTuningJobObjective specifies the objective metric used - // to evaluate the performance of training jobs launched by this tuning job. + // The HyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html) + // specifies the objective metric used to evaluate the performance of training + // jobs launched by this tuning job. HyperParameterTuningJobObjective *HyperParameterTuningJobObjective `type:"structure"` - // The ParameterRanges object that specifies the ranges of hyperparameters that - // this tuning job searches over to find the optimal configuration for the highest - // model performance against your chosen objective metric. + // The ParameterRanges (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ParameterRanges.html) + // object that specifies the ranges of hyperparameters that this tuning job + // searches over to find the optimal configuration for the highest model performance + // against your chosen objective metric. ParameterRanges *ParameterRanges `type:"structure"` // A value used to initialize a pseudo-random number generator. Setting a random @@ -71437,8 +71533,9 @@ type HyperParameterTuningJobConfig struct { // the two runs. RandomSeed *int64 `type:"integer"` - // The ResourceLimits object that specifies the maximum number of training and - // parallel training jobs that can be used for this hyperparameter tuning job. + // The ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html) + // object that specifies the maximum number of training and parallel training + // jobs that can be used for this hyperparameter tuning job. // // ResourceLimits is a required field ResourceLimits *ResourceLimits `type:"structure" required:"true"` @@ -71970,14 +72067,16 @@ type HyperParameterTuningJobSummary struct { // The date and time that the tuning job was modified. LastModifiedTime *time.Time `type:"timestamp"` - // The ObjectiveStatusCounters object that specifies the numbers of training - // jobs, categorized by objective metric status, that this tuning job launched. + // The ObjectiveStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html) + // object that specifies the numbers of training jobs, categorized by objective + // metric status, that this tuning job launched. // // ObjectiveStatusCounters is a required field ObjectiveStatusCounters *ObjectiveStatusCounters `type:"structure" required:"true"` - // The ResourceLimits object that specifies the maximum number of training jobs - // and parallel training jobs allowed for this tuning job. + // The ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html) + // object that specifies the maximum number of training jobs and parallel training + // jobs allowed for this tuning job. ResourceLimits *ResourceLimits `type:"structure"` // Specifies the search strategy hyperparameter tuning uses to choose which @@ -71986,8 +72085,9 @@ type HyperParameterTuningJobSummary struct { // Strategy is a required field Strategy *string `type:"string" required:"true" enum:"HyperParameterTuningJobStrategyType"` - // The TrainingJobStatusCounters object that specifies the numbers of training - // jobs, categorized by status, that this tuning job launched. + // The TrainingJobStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html) + // object that specifies the numbers of training jobs, categorized by status, + // that this tuning job launched. // // TrainingJobStatusCounters is a required field TrainingJobStatusCounters *TrainingJobStatusCounters `type:"structure" required:"true"` @@ -73755,8 +73855,7 @@ type InputConfig struct { _ struct{} `type:"structure"` // Specifies the name and shape of the expected data inputs for your trained - // model with a JSON dictionary form. The data inputs are InputConfig$Framework - // specific. + // model with a JSON dictionary form. The data inputs are Framework specific. // // * TensorFlow: You must specify the name and shape (NHWC format) of the // expected data inputs using a dictionary format for your trained model. @@ -73797,7 +73896,7 @@ type InputConfig struct { // // * XGBOOST: input data name and shape are not needed. // - // DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice + // DataInputConfig supports the following parameters for CoreML TargetDevice // (ML Model format): // // * shape: Input shape, for example {"input_1": {"shape": [1,224,224,3]}}. @@ -73823,9 +73922,9 @@ type InputConfig struct { // // * scale: If the input type is an Image, you need to provide a scale factor. // - // CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. - // CoreML converter supports Tensorflow and PyTorch models. CoreML conversion - // examples: + // CoreML ClassifierConfig parameters can be specified using OutputConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html) + // CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. + // CoreML conversion examples: // // * Tensor type input: "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], // [1,160,160,3]], "default_shape": [1,224,224,3]}} @@ -77275,7 +77374,7 @@ type ListCompilationJobsInput struct { // The sort order for results. The default is Ascending. SortOrder *string `type:"string" enum:"SortOrder"` - // A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus + // A filter that retrieves model compilation jobs with a specific CompilationJobStatus // status. StatusEquals *string `type:"string" enum:"CompilationJobStatus"` } @@ -77374,8 +77473,8 @@ func (s *ListCompilationJobsInput) SetStatusEquals(v string) *ListCompilationJob type ListCompilationJobsOutput struct { _ struct{} `type:"structure"` - // An array of CompilationJobSummary objects, each describing a model compilation - // job. + // An array of CompilationJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html) + // objects, each describing a model compilation job. // // CompilationJobSummaries is a required field CompilationJobSummaries []*CompilationJobSummary `type:"list" required:"true"` @@ -79965,8 +80064,9 @@ func (s *ListHyperParameterTuningJobsInput) SetStatusEquals(v string) *ListHyper type ListHyperParameterTuningJobsOutput struct { _ struct{} `type:"structure"` - // A list of HyperParameterTuningJobSummary objects that describe the tuning - // jobs that the ListHyperParameterTuningJobs request returned. + // A list of HyperParameterTuningJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html) + // objects that describe the tuning jobs that the ListHyperParameterTuningJobs + // request returned. // // HyperParameterTuningJobSummaries is a required field HyperParameterTuningJobSummaries []*HyperParameterTuningJobSummary `type:"list" required:"true"` @@ -80363,11 +80463,11 @@ type ListInferenceExperimentsInput struct { SortOrder *string `type:"string" enum:"SortOrder"` // Selects inference experiments which are in this status. For the possible - // statuses, see DescribeInferenceExperimentResponse$Status. + // statuses, see DescribeInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html). StatusEquals *string `type:"string" enum:"InferenceExperimentStatus"` // Selects inference experiments of this type. For the possible types of inference - // experiments, see CreateInferenceExperimentRequest$Type. + // experiments, see CreateInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html). Type *string `type:"string" enum:"InferenceExperimentType"` } @@ -85556,8 +85656,9 @@ type ListTrainingJobsForHyperParameterTuningJobOutput struct { // of training jobs, use the token in the next request. NextToken *string `type:"string"` - // A list of TrainingJobSummary objects that describe the training jobs that - // the ListTrainingJobsForHyperParameterTuningJob request returned. + // A list of TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) + // objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob + // request returned. // // TrainingJobSummaries is a required field TrainingJobSummaries []*HyperParameterTrainingJobSummary `type:"list" required:"true"` @@ -87042,7 +87143,8 @@ func (s *MetricsSource) SetS3Uri(v string) *MetricsSource { return s } -// The properties of a model as returned by the Search API. +// The properties of a model as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API. type Model struct { _ struct{} `type:"structure"` @@ -87408,7 +87510,7 @@ func (s *ModelBiasJobInput) SetGroundTruthS3Input(v *MonitoringGroundTruthS3Inpu type ModelCard struct { _ struct{} `type:"structure"` - // The content of the model card. Content uses the model card JSON schema (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) + // The content of the model card. Content uses the model card JSON schema (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) // and provided as a string. // // Content is a sensitive parameter and its value will be @@ -90596,6 +90698,63 @@ func (s *ModelQualityJobInput) SetGroundTruthS3Input(v *MonitoringGroundTruthS3I return s } +// The model registry settings for the SageMaker Canvas application. +type ModelRegisterSettings struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the SageMaker model registry account. Required + // only to register model versions created by a different SageMaker Canvas AWS + // account than the AWS account in which SageMaker model registry is set up. + CrossAccountModelRegisterRoleArn *string `min:"20" type:"string"` + + // Describes whether the integration to the model registry is enabled or disabled + // in the Canvas application. + Status *string `type:"string" enum:"FeatureStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModelRegisterSettings) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModelRegisterSettings) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModelRegisterSettings) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModelRegisterSettings"} + if s.CrossAccountModelRegisterRoleArn != nil && len(*s.CrossAccountModelRegisterRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("CrossAccountModelRegisterRoleArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCrossAccountModelRegisterRoleArn sets the CrossAccountModelRegisterRoleArn field's value. +func (s *ModelRegisterSettings) SetCrossAccountModelRegisterRoleArn(v string) *ModelRegisterSettings { + s.CrossAccountModelRegisterRoleArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ModelRegisterSettings) SetStatus(v string) *ModelRegisterSettings { + s.Status = &v + return s +} + // Metadata for Model steps. type ModelStepMetadata struct { _ struct{} `type:"structure"` @@ -92718,10 +92877,11 @@ func (s *MultiModelConfig) SetModelCacheSetting(v string) *MultiModelConfig { return s } -// The VpcConfig configuration object that specifies the VPC that you want the -// compilation jobs to connect to. For more information on controlling access -// to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker -// Compilation Jobs Access to Resources in Your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). +// The VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) +// configuration object that specifies the VPC that you want the compilation +// jobs to connect to. For more information on controlling access to your Amazon +// S3 buckets used for compilation job, see Give Amazon SageMaker Compilation +// Jobs Access to Resources in Your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). type NeoVpcConfig struct { _ struct{} `type:"structure"` @@ -92790,8 +92950,10 @@ func (s *NeoVpcConfig) SetSubnets(v []*string) *NeoVpcConfig { return s } -// A list of nested Filter objects. A resource must satisfy the conditions of -// all filters to be included in the results returned from the Search API. +// A list of nested Filter (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Filter.html) +// objects. A resource must satisfy the conditions of all filters to be included +// in the results returned from the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API. // // For example, to filter on a training job's InputDataConfig property with // a specific channel name and S3Uri prefix, define the following filters: @@ -93318,7 +93480,11 @@ type OfflineStoreConfig struct { DataCatalogConfig *DataCatalogConfig `type:"structure"` // Set to True to disable the automatic creation of an Amazon Web Services Glue - // table when configuring an OfflineStore. + // table when configuring an OfflineStore. If set to False, Feature Store will + // name the OfflineStore Glue table following Athena's naming recommendations + // (https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html). + // + // The default value is False. DisableGlueTableCreation *bool `type:"boolean"` // The Amazon Simple Storage (Amazon S3) location of OfflineStore. @@ -93737,8 +93903,9 @@ func (s *OidcMemberDefinition) SetGroups(v []*string) *OidcMemberDefinition { // Use this to specify the Amazon Web Services Key Management Service (KMS) // Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore -// on or off by specifying the EnableOnlineStore flag at General Assembly; the -// default value is False. +// on or off by specifying the EnableOnlineStore flag at General Assembly. +// +// The default value is False. type OnlineStoreConfig struct { _ struct{} `type:"structure"` @@ -93893,11 +94060,11 @@ type OutputConfig struct { // 2 -O2\"". For information about supported compiler options, see Neuron // Compiler CLI (https://github.com/aws/aws-neuron-sdk/blob/master/docs/neuron-cc/command-line-reference.md). // - // * CoreML: Compilation for the CoreML OutputConfig$TargetDevice supports - // the following compiler options: class_labels: Specifies the classification - // labels file name inside input tar.gz file. For example, {"class_labels": - // "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated - // by newlines. + // * CoreML: Compilation for the CoreML OutputConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html) + // TargetDevice supports the following compiler options: class_labels: Specifies + // the classification labels file name inside input tar.gz file. For example, + // {"class_labels": "imagenet_labels_1000.txt"}. Labels inside the txt file + // should be separated by newlines. // // * EIA: Compilation for the Elastic Inference Accelerator supports the // following compiler options: precision_mode: Specifies the precision of @@ -93935,8 +94102,8 @@ type OutputConfig struct { // Identifies the target device or the machine learning instance that you want // to run your model on after the compilation has completed. Alternatively, - // you can specify OS, architecture, and accelerator using TargetPlatform fields. - // It can be used instead of TargetPlatform. + // you can specify OS, architecture, and accelerator using TargetPlatform (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TargetPlatform.html) + // fields. It can be used instead of TargetPlatform. TargetDevice *string `type:"string" enum:"TargetDevice"` // Contains information about a target platform that you want your model to @@ -94390,16 +94557,19 @@ func (s *ParameterRange) SetIntegerParameterRangeSpecification(v *IntegerParamet type ParameterRanges struct { _ struct{} `type:"structure"` - // The array of CategoricalParameterRange objects that specify ranges of categorical - // hyperparameters that a hyperparameter tuning job searches. + // The array of CategoricalParameterRange (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CategoricalParameterRange.html) + // objects that specify ranges of categorical hyperparameters that a hyperparameter + // tuning job searches. CategoricalParameterRanges []*CategoricalParameterRange `type:"list"` - // The array of ContinuousParameterRange objects that specify ranges of continuous - // hyperparameters that a hyperparameter tuning job searches. + // The array of ContinuousParameterRange (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContinuousParameterRange.html) + // objects that specify ranges of continuous hyperparameters that a hyperparameter + // tuning job searches. ContinuousParameterRanges []*ContinuousParameterRange `type:"list"` - // The array of IntegerParameterRange objects that specify ranges of integer - // hyperparameters that a hyperparameter tuning job searches. + // The array of IntegerParameterRange (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_IntegerParameterRange.html) + // objects that specify ranges of integer hyperparameters that a hyperparameter + // tuning job searches. IntegerParameterRanges []*IntegerParameterRange `type:"list"` } @@ -94579,13 +94749,15 @@ type PendingDeploymentSummary struct { // EndpointConfigName is a required field EndpointConfigName *string `type:"string" required:"true"` - // An array of PendingProductionVariantSummary objects, one for each model hosted - // behind this endpoint for the in-progress deployment. + // An array of PendingProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html) + // objects, one for each model hosted behind this endpoint for the in-progress + // deployment. ProductionVariants []*PendingProductionVariantSummary `min:"1" type:"list"` - // An array of PendingProductionVariantSummary objects, one for each model hosted - // behind this endpoint in shadow mode with production traffic replicated from - // the model specified on ProductionVariants for the in-progress deployment. + // An array of PendingProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html) + // objects, one for each model hosted behind this endpoint in shadow mode with + // production traffic replicated from the model specified on ProductionVariants + // for the in-progress deployment. ShadowProductionVariants []*PendingProductionVariantSummary `min:"1" type:"list"` // The start time of the deployment. @@ -94635,9 +94807,10 @@ func (s *PendingDeploymentSummary) SetStartTime(v time.Time) *PendingDeploymentS } // The production variant summary for a deployment when an endpoint is creating -// or updating with the CreateEndpoint or UpdateEndpoint operations. Describes -// the VariantStatus , weight and capacity for a production variant associated -// with an endpoint. +// or updating with the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) +// or UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) +// operations. Describes the VariantStatus , weight and capacity for a production +// variant associated with an endpoint. type PendingProductionVariantSummary struct { _ struct{} `type:"structure"` @@ -94661,7 +94834,8 @@ type PendingProductionVariantSummary struct { // The number of instances requested in this deployment, as specified in the // endpoint configuration for the endpoint. The value is taken from the request - // to the CreateEndpointConfig operation. + // to the CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) + // operation. DesiredInstanceCount *int64 `type:"integer"` // The serverless configuration requested for this deployment, as specified @@ -94670,7 +94844,8 @@ type PendingProductionVariantSummary struct { // The requested weight for the variant in this deployment, as specified in // the endpoint configuration for the endpoint. The value is taken from the - // request to the CreateEndpointConfig operation. + // request to the CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) + // operation. DesiredWeight *float64 `type:"float"` // The type of instances associated with the variant. @@ -96002,11 +96177,11 @@ type ProcessingJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // A string, up to one KB in size, that contains the reason a processing job @@ -100175,7 +100350,8 @@ type RenderUiTemplateInput struct { // The HumanTaskUiArn of the worker UI that you want to render. Do not provide // a HumanTaskUiArn if you use the UiTemplate parameter. // - // See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig. + // See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html). HumanTaskUiArn *string `type:"string"` // The Amazon Resource Name (ARN) that has access to the S3 objects that are @@ -101837,7 +102013,8 @@ func (s *SearchOutput) SetResults(v []*SearchRecord) *SearchOutput { return s } -// A single resource returned as part of the Search API response. +// A single resource returned as part of the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API response. type SearchRecord struct { _ struct{} `type:"structure"` @@ -101999,7 +102176,7 @@ func (s *SearchRecord) SetTrialComponent(v *TrialComponent) *SearchRecord { return s } -// An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. +// An array element of SecondaryStatusTransitions for DescribeTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html). // It provides additional details about a status that the training job has transitioned // through. A training job can be in one of several states, for example, starting, // downloading, training, or uploading. Within each state, there are a number @@ -102096,8 +102273,9 @@ type SecondaryStatusTransition struct { // use status messages in if statements. // // To have an overview of your training job's progress, view TrainingJobStatus - // and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For - // example, at the start of a training job, you might see the following: + // and SecondaryStatus in DescribeTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html), + // and StatusMessage together. For example, at the start of a training job, + // you might see the following: // // * TrainingJobStatus - InProgress // @@ -104958,8 +105136,8 @@ func (s *SubscribedWorkteam) SetWorkteamArn(v string) *SubscribedWorkteam { return s } -// Specified in the GetSearchSuggestions request. Limits the property names -// that are included in the response. +// Specified in the GetSearchSuggestions (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_GetSearchSuggestions.html) +// request. Limits the property names that are included in the response. type SuggestionQuery struct { _ struct{} `type:"structure"` @@ -105013,7 +105191,7 @@ func (s *SuggestionQuery) SetPropertyNameQuery(v *PropertyNameQuery) *Suggestion // You can add tags to notebook instances, training jobs, hyperparameter tuning // jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, // and endpoints. For more information on adding tags to SageMaker resources, -// see AddTags. +// see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html). // // For more information on adding metadata to your Amazon Web Services resources // with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). @@ -105343,22 +105521,22 @@ func (s *TextClassificationJobConfig) SetTargetLabelColumn(v string) *TextClassi return s } -// Time series forecast settings for the SageMaker Canvas app. +// Time series forecast settings for the SageMaker Canvas application. type TimeSeriesForecastingSettings struct { _ struct{} `type:"structure"` // The IAM role that Canvas passes to Amazon Forecast for time series forecasting. // By default, Canvas uses the execution role specified in the UserProfile that - // launches the Canvas app. If an execution role is not specified in the UserProfile, - // Canvas uses the execution role specified in the Domain that owns the UserProfile. - // To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess - // (https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess) + // launches the Canvas application. If an execution role is not specified in + // the UserProfile, Canvas uses the execution role specified in the Domain that + // owns the UserProfile. To allow time series forecasting, this IAM role should + // have the AmazonSageMakerCanvasForecastAccess (https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess) // policy attached and forecast.amazonaws.com added in the trust relationship // as a service principal. AmazonForecastRoleArn *string `min:"20" type:"string"` // Describes whether time series forecasting is enabled or disabled in the Canvas - // app. + // application. Status *string `type:"string" enum:"FeatureStatus"` } @@ -105692,11 +105870,11 @@ type TrainingJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // If the training job failed, the reason it failed. @@ -105739,7 +105917,7 @@ type TrainingJob struct { // Provides detailed information about the state of the training job. For detailed // information about the secondary status of the training job, see StatusMessage - // under SecondaryStatusTransition. + // under SecondaryStatusTransition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html). // // SageMaker provides primary statuses and secondary statuses that apply to // each of them: @@ -105858,9 +106036,10 @@ type TrainingJob struct { // if the training job was launched by a hyperparameter tuning job. TuningJobArn *string `type:"string"` - // A VpcConfig object that specifies the VPC that this training job has access - // to. For more information, see Protect Training Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) + // object that specifies the VPC that this training job has access to. For more + // information, see Protect Training Jobs by Using an Amazon Virtual Private + // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). VpcConfig *VpcConfig `type:"structure"` } @@ -106911,11 +107090,11 @@ type TransformJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: // - // * CreateProcessingJob + // * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) // - // * CreateTrainingJob + // * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // - // * CreateTransformJob + // * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) ExperimentConfig *ExperimentConfig `type:"structure"` // If the transform job failed, the reason it failed. @@ -107311,7 +107490,8 @@ func (s *TransformJobStepMetadata) SetArn(v string) *TransformJobStepMetadata { } // Provides a summary of a transform job. Multiple TransformJobSummary objects -// are returned as a list after in response to a ListTransformJobs call. +// are returned as a list after in response to a ListTransformJobs (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTransformJobs.html) +// call. type TransformJobSummary struct { _ struct{} `type:"structure"` @@ -107706,7 +107886,8 @@ func (s *TransformS3DataSource) SetS3Uri(v string) *TransformS3DataSource { return s } -// The properties of a trial as returned by the Search API. +// The properties of a trial as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API. type Trial struct { _ struct{} `type:"structure"` @@ -107736,8 +107917,8 @@ type Trial struct { // The source of the trial. Source *TrialSource `type:"structure"` - // The list of tags that are associated with the trial. You can use Search API - // to search on the tags. + // The list of tags that are associated with the trial. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) + // API to search on the tags. Tags []*Tag `type:"list"` // The Amazon Resource Name (ARN) of the trial. @@ -107841,7 +108022,8 @@ func (s *Trial) SetTrialName(v string) *Trial { return s } -// The properties of a trial component as returned by the Search API. +// The properties of a trial component as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) +// API. type TrialComponent struct { _ struct{} `type:"structure"` @@ -107904,6 +108086,7 @@ type TrialComponent struct { Status *TrialComponentStatus `type:"structure"` // The list of tags that are associated with the component. You can use Search + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) // API to search on the tags. Tags []*Tag `type:"list"` @@ -108060,7 +108243,8 @@ func (s *TrialComponent) SetTrialComponentName(v string) *TrialComponent { // Represents an input or output artifact of a trial component. You specify // TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts -// parameters in the CreateTrialComponent request. +// parameters in the CreateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) +// request. // // Examples of input artifacts are datasets, algorithms, hyperparameters, source // code, and instance types. Examples of output artifacts are metrics, snapshots, @@ -108230,7 +108414,8 @@ func (s *TrialComponentMetricSummary) SetTimeStamp(v time.Time) *TrialComponentM // The value of a hyperparameter. Only one of NumberValue or StringValue can // be specified. // -// This object is specified in the CreateTrialComponent request. +// This object is specified in the CreateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) +// request. type TrialComponentParameterValue struct { _ struct{} `type:"structure"` @@ -108487,7 +108672,8 @@ func (s *TrialComponentStatus) SetPrimaryStatus(v string) *TrialComponentStatus } // A summary of the properties of a trial component. To get all the properties, -// call the DescribeTrialComponent API and provide the TrialComponentName. +// call the DescribeTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html) +// API and provide the TrialComponentName. type TrialComponentSummary struct { _ struct{} `type:"structure"` @@ -108660,7 +108846,8 @@ func (s *TrialSource) SetSourceType(v string) *TrialSource { } // A summary of the properties of a trial. To get the complete set of properties, -// call the DescribeTrial API and provide the TrialName. +// call the DescribeTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html) +// API and provide the TrialName. type TrialSummary struct { _ struct{} `type:"structure"` @@ -109967,11 +110154,11 @@ type UpdateEndpointInput struct { // EndpointName is a required field EndpointName *string `type:"string" required:"true"` - // When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, + // When you are updating endpoint resources with RetainAllVariantProperties, // whose value is set to true, ExcludeRetainedVariantProperties specifies the - // list of type VariantProperty to override with the values provided by EndpointConfig. - // If you don't specify a value for ExcludeRetainedVariantProperties, no variant - // properties are overridden. + // list of type VariantProperty (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html) + // to override with the values provided by EndpointConfig. If you don't specify + // a value for ExcludeRetainedVariantProperties, no variant properties are overridden. ExcludeRetainedVariantProperties []*VariantProperty `type:"list"` // When updating endpoint resources, enables or disables the retention of variant @@ -111158,7 +111345,7 @@ type UpdateModelCardInput struct { _ struct{} `type:"structure"` // The updated model card content. Content must be in model card JSON schema - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) + // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) // and provided as a string. // // When updating model card content, be sure to include the full content and @@ -113061,7 +113248,8 @@ type UpdateWorkforceInput struct { SourceIpConfig *SourceIpConfig `type:"structure"` // The name of the private workforce that you want to update. You can find your - // workforce name by using the operation. + // workforce name by using the ListWorkforces (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html) + // operation. // // WorkforceName is a required field WorkforceName *string `min:"1" type:"string" required:"true"` @@ -113488,7 +113676,8 @@ type UserSettings struct { // // Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly. // - // Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly. + // Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, + // unless specified as part of the DefaultUserSettings for the domain. // // Amazon SageMaker adds a security group to allow NFS traffic from SageMaker // Studio. Therefore, the number of security groups that you can specify is @@ -113609,8 +113798,10 @@ func (s *UserSettings) SetTensorBoardAppSettings(v *TensorBoardAppSettings) *Use // Specifies a production variant property type for an Endpoint. // -// If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties -// option set to true, the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties +// If you are updating an endpoint with the RetainAllVariantProperties option +// of UpdateEndpointInput (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) +// set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties +// parameter of UpdateEndpointInput (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) // override the existing variant properties of the endpoint. type VariantProperty struct { _ struct{} `type:"structure"` @@ -113618,10 +113809,11 @@ type VariantProperty struct { // The type of variant property. The supported values are: // // * DesiredInstanceCount: Overrides the existing variant instance counts - // using the ProductionVariant$InitialInstanceCount values in the CreateEndpointConfigInput$ProductionVariants. + // using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html). // - // * DesiredWeight: Overrides the existing variant weights using the ProductionVariant$InitialVariantWeight - // values in the CreateEndpointConfigInput$ProductionVariants. + // * DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight + // values in the ProductionVariants of CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html). // // * DataCaptureConfig: (Not currently supported.) // @@ -113879,8 +114071,8 @@ type Workforce struct { // The reason your workforce failed. FailureReason *string `min:"1" type:"string"` - // The most recent date that was used to successfully add one or more IP address - // ranges (CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) + // The most recent date that UpdateWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateWorkforce.html) + // was used to successfully add one or more IP address ranges (CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) // to a private workforce's allow list. LastUpdatedDate *time.Time `type:"timestamp"` diff --git a/service/snowball/api.go b/service/snowball/api.go index 060a4426f5..137842984b 100644 --- a/service/snowball/api.go +++ b/service/snowball/api.go @@ -353,7 +353,7 @@ func (c *Snowball) CreateClusterRequest(input *CreateClusterInput) (req *request // and try again. // // - Ec2RequestFailedException -// Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted +// Your user lacks the necessary Amazon EC2 permissions to perform the attempted // action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateCluster @@ -438,9 +438,9 @@ func (c *Snowball) CreateJobRequest(input *CreateJobInput) (req *request.Request // // Snow Family devices and their capacities. // -// - Snow Family device type: SNC1_SSD Capacity: T14 Description: Snowcone +// - Device type: SNC1_SSD Capacity: T14 Description: Snowcone // -// - Snow Family device type: SNC1_HDD Capacity: T8 Description: Snowcone +// - Device type: SNC1_HDD Capacity: T8 Description: Snowcone // // - Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage // Optimized for data transfer only @@ -462,6 +462,12 @@ func (c *Snowball) CreateJobRequest(input *CreateJobInput) (req *request.Request // This device is only available in the Ningxia, Beijing, and Singapore Amazon // Web Services Region. // +// - Device type: V3_5C Capacity: T32 Description: Snowball Edge Compute +// Optimized without GPU +// +// - Device type: V3_5S Capacity: T240 Description: Snowball Edge Storage +// Optimized 210TB +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -491,7 +497,7 @@ func (c *Snowball) CreateJobRequest(input *CreateJobInput) (req *request.Request // five nodes. // // - Ec2RequestFailedException -// Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted +// Your user lacks the necessary Amazon EC2 permissions to perform the attempted // action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJob @@ -1866,9 +1872,11 @@ func (c *Snowball) ListCompatibleImagesRequest(input *ListCompatibleImagesInput) // // This action returns a list of the different Amazon EC2 Amazon Machine Images // (AMIs) that are owned by your Amazon Web Services accountthat would be supported -// for use on a Snow device. Currently, supported AMIs are based on the CentOS -// 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu -// 16.04 LTS - Xenial (HVM) images, available on the Amazon Web Services Marketplace. +// for use on a Snow device. Currently, supported AMIs are based on the Amazon +// Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available +// on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images +// are no longer supported in the Market, but still supported for use on devices +// through Amazon EC2 VM Import/Export and running locally in AMIs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1884,7 +1892,7 @@ func (c *Snowball) ListCompatibleImagesRequest(input *ListCompatibleImagesInput) // Run the operation without changing the NextToken string, and try again. // // - Ec2RequestFailedException -// Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted +// Your user lacks the necessary Amazon EC2 permissions to perform the attempted // action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListCompatibleImages @@ -2403,7 +2411,7 @@ func (c *Snowball) UpdateClusterRequest(input *UpdateClusterInput) (req *request // and try again. // // - Ec2RequestFailedException -// Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted +// Your user lacks the necessary Amazon EC2 permissions to perform the attempted // action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateCluster @@ -2509,7 +2517,7 @@ func (c *Snowball) UpdateJobRequest(input *UpdateJobInput) (req *request.Request // five nodes. // // - Ec2RequestFailedException -// Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted +// Your user lacks the necessary Amazon EC2 permissions to perform the attempted // action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJob @@ -3573,10 +3581,20 @@ type CreateClusterInput struct { // Data Cluster-01. Description *string `min:"1" type:"string"` + // Force to create cluster when user attempts to overprovision or underprovision + // a cluster. A cluster is overprovisioned or underprovisioned if the initial + // size of the cluster is more (overprovisioned) or less (underprovisioned) + // than what needed to meet capacity requirement specified with OnDeviceServiceConfiguration. + ForceCreateJobs *bool `type:"boolean"` + // The forwarding address ID for a cluster. This field is not supported in most // regions. ForwardingAddressId *string `min:"40" type:"string"` + // If provided, each job will be automatically created and associated with the + // new cluster. If not provided, will be treated as 0. + InitialClusterSize *int64 `type:"integer"` + // The type of job for this cluster. Currently, the only job type supported // for clusters is LOCAL_USE. // @@ -3592,6 +3610,10 @@ type CreateClusterInput struct { // API action in Key Management Service (KMS). KmsKeyARN *string `type:"string"` + // Lists long-term pricing id that will be used to associate with jobs automatically + // created for the new cluster. + LongTermPricingIds []*string `type:"list"` + // The Amazon Simple Notification Service (Amazon SNS) notification settings // for this cluster. Notification *Notification `type:"structure"` @@ -3609,16 +3631,12 @@ type CreateClusterInput struct { // The resources associated with the cluster job. These resources include Amazon // S3 buckets and optional Lambda functions written in the Python language. - // - // Resources is a required field - Resources *JobResource `type:"structure" required:"true"` + Resources *JobResource `type:"structure"` // The RoleARN that you want to associate with this cluster. RoleArn values // are created by using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in Identity and Access Management (IAM). - // - // RoleARN is a required field - RoleARN *string `type:"string" required:"true"` + RoleARN *string `type:"string"` // The shipping speed for each node in this cluster. This speed doesn't dictate // how soon you'll get each Snowball Edge device, rather it represents how quickly @@ -3653,6 +3671,15 @@ type CreateClusterInput struct { // ShippingOption is a required field ShippingOption *string `type:"string" required:"true" enum:"ShippingOption"` + // If your job is being created in one of the US regions, you have the option + // of specifying what size Snow device you'd like for this job. In all other + // regions, Snowballs come with 80 TB in storage capacity. + // + // For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" + // (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" + // (Snow Family Devices and Capacity) in the Snowcone User Guide. + SnowballCapacityPreference *string `type:"string" enum:"Capacity"` + // The type of Snow Family devices to use for this cluster. // // For cluster jobs, Amazon Web Services Snow Family currently supports only @@ -3705,12 +3732,6 @@ func (s *CreateClusterInput) Validate() error { if s.JobType == nil { invalidParams.Add(request.NewErrParamRequired("JobType")) } - if s.Resources == nil { - invalidParams.Add(request.NewErrParamRequired("Resources")) - } - if s.RoleARN == nil { - invalidParams.Add(request.NewErrParamRequired("RoleARN")) - } if s.ShippingOption == nil { invalidParams.Add(request.NewErrParamRequired("ShippingOption")) } @@ -3751,12 +3772,24 @@ func (s *CreateClusterInput) SetDescription(v string) *CreateClusterInput { return s } +// SetForceCreateJobs sets the ForceCreateJobs field's value. +func (s *CreateClusterInput) SetForceCreateJobs(v bool) *CreateClusterInput { + s.ForceCreateJobs = &v + return s +} + // SetForwardingAddressId sets the ForwardingAddressId field's value. func (s *CreateClusterInput) SetForwardingAddressId(v string) *CreateClusterInput { s.ForwardingAddressId = &v return s } +// SetInitialClusterSize sets the InitialClusterSize field's value. +func (s *CreateClusterInput) SetInitialClusterSize(v int64) *CreateClusterInput { + s.InitialClusterSize = &v + return s +} + // SetJobType sets the JobType field's value. func (s *CreateClusterInput) SetJobType(v string) *CreateClusterInput { s.JobType = &v @@ -3769,6 +3802,12 @@ func (s *CreateClusterInput) SetKmsKeyARN(v string) *CreateClusterInput { return s } +// SetLongTermPricingIds sets the LongTermPricingIds field's value. +func (s *CreateClusterInput) SetLongTermPricingIds(v []*string) *CreateClusterInput { + s.LongTermPricingIds = v + return s +} + // SetNotification sets the Notification field's value. func (s *CreateClusterInput) SetNotification(v *Notification) *CreateClusterInput { s.Notification = v @@ -3805,6 +3844,12 @@ func (s *CreateClusterInput) SetShippingOption(v string) *CreateClusterInput { return s } +// SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value. +func (s *CreateClusterInput) SetSnowballCapacityPreference(v string) *CreateClusterInput { + s.SnowballCapacityPreference = &v + return s +} + // SetSnowballType sets the SnowballType field's value. func (s *CreateClusterInput) SetSnowballType(v string) *CreateClusterInput { s.SnowballType = &v @@ -3822,6 +3867,11 @@ type CreateClusterOutput struct { // The automatically generated ID for a cluster. ClusterId *string `min:"39" type:"string"` + + // List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries + // (https://docs.aws.amazon.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax) + // in this guide. + JobListEntries []*JobListEntry `type:"list"` } // String returns the string representation. @@ -3848,6 +3898,12 @@ func (s *CreateClusterOutput) SetClusterId(v string) *CreateClusterOutput { return s } +// SetJobListEntries sets the JobListEntries field's value. +func (s *CreateClusterOutput) SetJobListEntries(v []*JobListEntry) *CreateClusterOutput { + s.JobListEntries = v + return s +} + type CreateJobInput struct { _ struct{} `type:"structure"` @@ -5071,7 +5127,7 @@ func (s *Ec2AmiResource) SetSnowballAmiId(v string) *Ec2AmiResource { return s } -// Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted +// Your user lacks the necessary Amazon EC2 permissions to perform the attempted // action. type Ec2RequestFailedException struct { _ struct{} `type:"structure"` @@ -7409,6 +7465,9 @@ type OnDeviceServiceConfiguration struct { // Represents the NFS (Network File System) service on a Snow Family device. NFSOnDeviceService *NFSOnDeviceServiceConfiguration `type:"structure"` + // Configuration for Amazon S3 compatible storage on Snow family devices. + S3OnDeviceService *S3OnDeviceServiceConfiguration `type:"structure"` + // Represents the Storage Gateway service Tape Gateway type on a Snow Family // device. TGWOnDeviceService *TGWOnDeviceServiceConfiguration `type:"structure"` @@ -7440,6 +7499,11 @@ func (s *OnDeviceServiceConfiguration) Validate() error { invalidParams.AddNested("EKSOnDeviceService", err.(request.ErrInvalidParams)) } } + if s.S3OnDeviceService != nil { + if err := s.S3OnDeviceService.Validate(); err != nil { + invalidParams.AddNested("S3OnDeviceService", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -7459,6 +7523,12 @@ func (s *OnDeviceServiceConfiguration) SetNFSOnDeviceService(v *NFSOnDeviceServi return s } +// SetS3OnDeviceService sets the S3OnDeviceService field's value. +func (s *OnDeviceServiceConfiguration) SetS3OnDeviceService(v *S3OnDeviceServiceConfiguration) *OnDeviceServiceConfiguration { + s.S3OnDeviceService = v + return s +} + // SetTGWOnDeviceService sets the TGWOnDeviceService field's value. func (s *OnDeviceServiceConfiguration) SetTGWOnDeviceService(v *TGWOnDeviceServiceConfiguration) *OnDeviceServiceConfiguration { s.TGWOnDeviceService = v @@ -7531,6 +7601,90 @@ func (s *ReturnShippingLabelAlreadyExistsException) RequestID() string { return s.RespMetadata.RequestID } +// Amazon S3 compatible storage on Snow family devices configuration items. +type S3OnDeviceServiceConfiguration struct { + _ struct{} `type:"structure"` + + // >Fault tolerance level of the cluster. This indicates the number of nodes + // that can go down without degrading the performance of the cluster. This additional + // input helps when the specified StorageLimit matches more than one Amazon + // S3 compatible storage on Snow family devices service configuration. + FaultTolerance *int64 `min:"1" type:"integer"` + + // Applicable when creating a cluster. Specifies how many nodes are needed for + // Amazon S3 compatible storage on Snow family devices. If specified, the other + // input can be omitted. + ServiceSize *int64 `min:"3" type:"integer"` + + // If the specified storage limit value matches storage limit of one of the + // defined configurations, that configuration will be used. If the specified + // storage limit value does not match any defined configuration, the request + // will fail. If more than one configuration has the same storage limit as specified, + // the other input need to be provided. + StorageLimit *float64 `type:"double"` + + // Storage unit. Currently the only supported unit is TB. + StorageUnit *string `type:"string" enum:"StorageUnit"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3OnDeviceServiceConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3OnDeviceServiceConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3OnDeviceServiceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3OnDeviceServiceConfiguration"} + if s.FaultTolerance != nil && *s.FaultTolerance < 1 { + invalidParams.Add(request.NewErrParamMinValue("FaultTolerance", 1)) + } + if s.ServiceSize != nil && *s.ServiceSize < 3 { + invalidParams.Add(request.NewErrParamMinValue("ServiceSize", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFaultTolerance sets the FaultTolerance field's value. +func (s *S3OnDeviceServiceConfiguration) SetFaultTolerance(v int64) *S3OnDeviceServiceConfiguration { + s.FaultTolerance = &v + return s +} + +// SetServiceSize sets the ServiceSize field's value. +func (s *S3OnDeviceServiceConfiguration) SetServiceSize(v int64) *S3OnDeviceServiceConfiguration { + s.ServiceSize = &v + return s +} + +// SetStorageLimit sets the StorageLimit field's value. +func (s *S3OnDeviceServiceConfiguration) SetStorageLimit(v float64) *S3OnDeviceServiceConfiguration { + s.StorageLimit = &v + return s +} + +// SetStorageUnit sets the StorageUnit field's value. +func (s *S3OnDeviceServiceConfiguration) SetStorageUnit(v string) *S3OnDeviceServiceConfiguration { + s.StorageUnit = &v + return s +} + // Each S3Resource object represents an Amazon S3 bucket that your transferred // data will be exported from or imported into. For export jobs, this object // can have an optional KeyRange value. The length of the range is defined at @@ -8594,6 +8748,9 @@ const ( // CapacityNoPreference is a Capacity enum value CapacityNoPreference = "NoPreference" + + // CapacityT240 is a Capacity enum value + CapacityT240 = "T240" ) // Capacity_Values returns all elements of the Capacity enum @@ -8608,6 +8765,7 @@ func Capacity_Values() []string { CapacityT14, CapacityT32, CapacityNoPreference, + CapacityT240, } } @@ -8741,6 +8899,9 @@ const ( // LongTermPricingTypeThreeYear is a LongTermPricingType enum value LongTermPricingTypeThreeYear = "ThreeYear" + + // LongTermPricingTypeOneMonth is a LongTermPricingType enum value + LongTermPricingTypeOneMonth = "OneMonth" ) // LongTermPricingType_Values returns all elements of the LongTermPricingType enum @@ -8748,6 +8909,7 @@ func LongTermPricingType_Values() []string { return []string{ LongTermPricingTypeOneYear, LongTermPricingTypeThreeYear, + LongTermPricingTypeOneMonth, } } @@ -8903,6 +9065,9 @@ const ( // TypeV35c is a Type enum value TypeV35c = "V3_5C" + + // TypeV35s is a Type enum value + TypeV35s = "V3_5S" ) // Type_Values returns all elements of the Type enum @@ -8916,5 +9081,6 @@ func Type_Values() []string { TypeSnc1Hdd, TypeSnc1Ssd, TypeV35c, + TypeV35s, } } diff --git a/service/snowball/errors.go b/service/snowball/errors.go index 8f140ce95b..1f81035892 100644 --- a/service/snowball/errors.go +++ b/service/snowball/errors.go @@ -27,7 +27,7 @@ const ( // ErrCodeEc2RequestFailedException for service response error code // "Ec2RequestFailedException". // - // Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted + // Your user lacks the necessary Amazon EC2 permissions to perform the attempted // action. ErrCodeEc2RequestFailedException = "Ec2RequestFailedException" diff --git a/service/wafv2/api.go b/service/wafv2/api.go index e734abc9a4..fe3f124ecb 100644 --- a/service/wafv2/api.go +++ b/service/wafv2/api.go @@ -288,6 +288,119 @@ func (c *WAFV2) CheckCapacityWithContext(ctx aws.Context, input *CheckCapacityIn return out, req.Send() } +const opCreateAPIKey = "CreateAPIKey" + +// CreateAPIKeyRequest generates a "aws/request.Request" representing the +// client's request for the CreateAPIKey operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateAPIKey for more information on using the CreateAPIKey +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateAPIKeyRequest method. +// req, resp := client.CreateAPIKeyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CreateAPIKey +func (c *WAFV2) CreateAPIKeyRequest(input *CreateAPIKeyInput) (req *request.Request, output *CreateAPIKeyOutput) { + op := &request.Operation{ + Name: opCreateAPIKey, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateAPIKeyInput{} + } + + output = &CreateAPIKeyOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateAPIKey API operation for AWS WAFV2. +// +// Creates an API key for use in the integration of the CAPTCHA API in your +// JavaScript client applications. The integration lets you customize the placement +// and characteristics of the CAPTCHA puzzle for your end users. For more information +// about the CAPTCHA JavaScript integration, see WAF client application integration +// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) +// in the WAF Developer Guide. +// +// The CAPTCHA API requires a key that authorizes CAPTCHA use from the client +// application domain. You can use a single key for up to 5 domains. After you +// generate a key, you can copy it for use in your JavaScript integration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS WAFV2's +// API operation CreateAPIKey for usage and error information. +// +// Returned Error Types: +// +// - WAFInternalErrorException +// Your request is valid, but WAF couldn’t perform the operation because of +// a system problem. Retry your request. +// +// - WAFInvalidParameterException +// The operation failed because WAF didn't recognize a parameter in the request. +// For example: +// +// - You specified a parameter name or value that isn't valid. +// +// - Your nested statement isn't valid. You might have tried to nest a statement +// that can’t be nested. +// +// - You tried to update a WebACL with a DefaultAction that isn't among the +// types available at DefaultAction. +// +// - Your request references an ARN that is malformed, or corresponds to +// a resource with which a web ACL can't be associated. +// +// - WAFInvalidOperationException +// The operation isn't valid. +// +// - WAFLimitsExceededException +// WAF couldn’t perform the operation because you exceeded your resource limit. +// For example, the maximum number of WebACL objects that you can create for +// an Amazon Web Services account. For more information, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) +// in the WAF Developer Guide. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CreateAPIKey +func (c *WAFV2) CreateAPIKey(input *CreateAPIKeyInput) (*CreateAPIKeyOutput, error) { + req, out := c.CreateAPIKeyRequest(input) + return out, req.Send() +} + +// CreateAPIKeyWithContext is the same as CreateAPIKey with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAPIKey for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *WAFV2) CreateAPIKeyWithContext(ctx aws.Context, input *CreateAPIKeyInput, opts ...request.Option) (*CreateAPIKeyOutput, error) { + req, out := c.CreateAPIKeyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateIPSet = "CreateIPSet" // CreateIPSetRequest generates a "aws/request.Request" representing the @@ -2014,6 +2127,109 @@ func (c *WAFV2) GenerateMobileSdkReleaseUrlWithContext(ctx aws.Context, input *G return out, req.Send() } +const opGetDecryptedAPIKey = "GetDecryptedAPIKey" + +// GetDecryptedAPIKeyRequest generates a "aws/request.Request" representing the +// client's request for the GetDecryptedAPIKey operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetDecryptedAPIKey for more information on using the GetDecryptedAPIKey +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetDecryptedAPIKeyRequest method. +// req, resp := client.GetDecryptedAPIKeyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetDecryptedAPIKey +func (c *WAFV2) GetDecryptedAPIKeyRequest(input *GetDecryptedAPIKeyInput) (req *request.Request, output *GetDecryptedAPIKeyOutput) { + op := &request.Operation{ + Name: opGetDecryptedAPIKey, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetDecryptedAPIKeyInput{} + } + + output = &GetDecryptedAPIKeyOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetDecryptedAPIKey API operation for AWS WAFV2. +// +// Returns your API key in decrypted form. Use this to check the token domains +// that you have defined for the key. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS WAFV2's +// API operation GetDecryptedAPIKey for usage and error information. +// +// Returned Error Types: +// +// - WAFInternalErrorException +// Your request is valid, but WAF couldn’t perform the operation because of +// a system problem. Retry your request. +// +// - WAFInvalidParameterException +// The operation failed because WAF didn't recognize a parameter in the request. +// For example: +// +// - You specified a parameter name or value that isn't valid. +// +// - Your nested statement isn't valid. You might have tried to nest a statement +// that can’t be nested. +// +// - You tried to update a WebACL with a DefaultAction that isn't among the +// types available at DefaultAction. +// +// - Your request references an ARN that is malformed, or corresponds to +// a resource with which a web ACL can't be associated. +// +// - WAFInvalidOperationException +// The operation isn't valid. +// +// - WAFInvalidResourceException +// WAF couldn’t perform the operation because the resource that you requested +// isn’t valid. Check the resource, and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetDecryptedAPIKey +func (c *WAFV2) GetDecryptedAPIKey(input *GetDecryptedAPIKeyInput) (*GetDecryptedAPIKeyOutput, error) { + req, out := c.GetDecryptedAPIKeyRequest(input) + return out, req.Send() +} + +// GetDecryptedAPIKeyWithContext is the same as GetDecryptedAPIKey with the addition of +// the ability to pass a context and additional request options. +// +// See GetDecryptedAPIKey for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *WAFV2) GetDecryptedAPIKeyWithContext(ctx aws.Context, input *GetDecryptedAPIKeyInput, opts ...request.Option) (*GetDecryptedAPIKeyOutput, error) { + req, out := c.GetDecryptedAPIKeyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetIPSet = "GetIPSet" // GetIPSetRequest generates a "aws/request.Request" representing the @@ -3201,6 +3417,108 @@ func (c *WAFV2) GetWebACLForResourceWithContext(ctx aws.Context, input *GetWebAC return out, req.Send() } +const opListAPIKeys = "ListAPIKeys" + +// ListAPIKeysRequest generates a "aws/request.Request" representing the +// client's request for the ListAPIKeys operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListAPIKeys for more information on using the ListAPIKeys +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListAPIKeysRequest method. +// req, resp := client.ListAPIKeysRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/ListAPIKeys +func (c *WAFV2) ListAPIKeysRequest(input *ListAPIKeysInput) (req *request.Request, output *ListAPIKeysOutput) { + op := &request.Operation{ + Name: opListAPIKeys, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ListAPIKeysInput{} + } + + output = &ListAPIKeysOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAPIKeys API operation for AWS WAFV2. +// +// Retrieves a list of the API keys that you've defined for the specified scope. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS WAFV2's +// API operation ListAPIKeys for usage and error information. +// +// Returned Error Types: +// +// - WAFInternalErrorException +// Your request is valid, but WAF couldn’t perform the operation because of +// a system problem. Retry your request. +// +// - WAFInvalidParameterException +// The operation failed because WAF didn't recognize a parameter in the request. +// For example: +// +// - You specified a parameter name or value that isn't valid. +// +// - Your nested statement isn't valid. You might have tried to nest a statement +// that can’t be nested. +// +// - You tried to update a WebACL with a DefaultAction that isn't among the +// types available at DefaultAction. +// +// - Your request references an ARN that is malformed, or corresponds to +// a resource with which a web ACL can't be associated. +// +// - WAFInvalidOperationException +// The operation isn't valid. +// +// - WAFInvalidResourceException +// WAF couldn’t perform the operation because the resource that you requested +// isn’t valid. Check the resource, and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/ListAPIKeys +func (c *WAFV2) ListAPIKeys(input *ListAPIKeysInput) (*ListAPIKeysOutput, error) { + req, out := c.ListAPIKeysRequest(input) + return out, req.Send() +} + +// ListAPIKeysWithContext is the same as ListAPIKeys with the addition of +// the ability to pass a context and additional request options. +// +// See ListAPIKeys for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *WAFV2) ListAPIKeysWithContext(ctx aws.Context, input *ListAPIKeysInput, opts ...request.Option) (*ListAPIKeysOutput, error) { + req, out := c.ListAPIKeysRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListAvailableManagedRuleGroupVersions = "ListAvailableManagedRuleGroupVersions" // ListAvailableManagedRuleGroupVersionsRequest generates a "aws/request.Request" representing the @@ -5779,6 +6097,70 @@ func (c *WAFV2) UpdateWebACLWithContext(ctx aws.Context, input *UpdateWebACLInpu return out, req.Send() } +// Information for a single API key. +type APIKeySummary struct { + _ struct{} `type:"structure"` + + // The generated, encrypted API key. You can copy this for use in your JavaScript + // CAPTCHA integration. + // + // For information about how to use this in your CAPTCHA JavaScript integration, + // see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) + // in the WAF Developer Guide. + APIKey *string `min:"1" type:"string"` + + // The date and time that the key was created. + CreationTimestamp *time.Time `type:"timestamp"` + + // The token domains that are defined in this API key. + TokenDomains []*string `type:"list"` + + // Internal value used by WAF to manage the key. + Version *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s APIKeySummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s APIKeySummary) GoString() string { + return s.String() +} + +// SetAPIKey sets the APIKey field's value. +func (s *APIKeySummary) SetAPIKey(v string) *APIKeySummary { + s.APIKey = &v + return s +} + +// SetCreationTimestamp sets the CreationTimestamp field's value. +func (s *APIKeySummary) SetCreationTimestamp(v time.Time) *APIKeySummary { + s.CreationTimestamp = &v + return s +} + +// SetTokenDomains sets the TokenDomains field's value. +func (s *APIKeySummary) SetTokenDomains(v []*string) *APIKeySummary { + s.TokenDomains = v + return s +} + +// SetVersion sets the Version field's value. +func (s *APIKeySummary) SetVersion(v int64) *APIKeySummary { + s.Version = &v + return s +} + // Details for your use of the account takeover prevention managed rule group, // AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig. type AWSManagedRulesATPRuleSet struct { @@ -7297,38 +7679,163 @@ func (s *Cookies) Validate() error { return nil } -// SetMatchPattern sets the MatchPattern field's value. -func (s *Cookies) SetMatchPattern(v *CookieMatchPattern) *Cookies { - s.MatchPattern = v - return s -} - -// SetMatchScope sets the MatchScope field's value. -func (s *Cookies) SetMatchScope(v string) *Cookies { - s.MatchScope = &v +// SetMatchPattern sets the MatchPattern field's value. +func (s *Cookies) SetMatchPattern(v *CookieMatchPattern) *Cookies { + s.MatchPattern = v + return s +} + +// SetMatchScope sets the MatchScope field's value. +func (s *Cookies) SetMatchScope(v string) *Cookies { + s.MatchScope = &v + return s +} + +// SetOversizeHandling sets the OversizeHandling field's value. +func (s *Cookies) SetOversizeHandling(v string) *Cookies { + s.OversizeHandling = &v + return s +} + +// Specifies that WAF should count the request. Optionally defines additional +// custom handling for the request. +// +// This is used in the context of other settings, for example to specify values +// for RuleAction and web ACL DefaultAction. +type CountAction struct { + _ struct{} `type:"structure"` + + // Defines custom handling for the web request. + // + // For information about customizing web requests and responses, see Customizing + // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide. + CustomRequestHandling *CustomRequestHandling `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CountAction) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CountAction) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CountAction) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CountAction"} + if s.CustomRequestHandling != nil { + if err := s.CustomRequestHandling.Validate(); err != nil { + invalidParams.AddNested("CustomRequestHandling", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCustomRequestHandling sets the CustomRequestHandling field's value. +func (s *CountAction) SetCustomRequestHandling(v *CustomRequestHandling) *CountAction { + s.CustomRequestHandling = v + return s +} + +type CreateAPIKeyInput struct { + _ struct{} `type:"structure"` + + // Specifies whether this is for an Amazon CloudFront distribution or for a + // regional application. A regional application can be an Application Load Balancer + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon + // Cognito user pool, or an App Runner service. + // + // To work with CloudFront, you must also specify the Region US East (N. Virginia) + // as follows: + // + // * CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT + // --region=us-east-1. + // + // * API and SDKs - For all calls, use the Region endpoint us-east-1. + // + // Scope is a required field + Scope *string `type:"string" required:"true" enum:"Scope"` + + // The client application domains that you want to use this API key for. + // + // TokenDomains is a required field + TokenDomains []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAPIKeyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAPIKeyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAPIKeyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAPIKeyInput"} + if s.Scope == nil { + invalidParams.Add(request.NewErrParamRequired("Scope")) + } + if s.TokenDomains == nil { + invalidParams.Add(request.NewErrParamRequired("TokenDomains")) + } + if s.TokenDomains != nil && len(s.TokenDomains) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TokenDomains", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetScope sets the Scope field's value. +func (s *CreateAPIKeyInput) SetScope(v string) *CreateAPIKeyInput { + s.Scope = &v return s } -// SetOversizeHandling sets the OversizeHandling field's value. -func (s *Cookies) SetOversizeHandling(v string) *Cookies { - s.OversizeHandling = &v +// SetTokenDomains sets the TokenDomains field's value. +func (s *CreateAPIKeyInput) SetTokenDomains(v []*string) *CreateAPIKeyInput { + s.TokenDomains = v return s } -// Specifies that WAF should count the request. Optionally defines additional -// custom handling for the request. -// -// This is used in the context of other settings, for example to specify values -// for RuleAction and web ACL DefaultAction. -type CountAction struct { +type CreateAPIKeyOutput struct { _ struct{} `type:"structure"` - // Defines custom handling for the web request. + // The generated, encrypted API key. You can copy this for use in your JavaScript + // CAPTCHA integration. // - // For information about customizing web requests and responses, see Customizing - // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // For information about how to use this in your CAPTCHA JavaScript integration, + // see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) // in the WAF Developer Guide. - CustomRequestHandling *CustomRequestHandling `type:"structure"` + APIKey *string `min:"1" type:"string"` } // String returns the string representation. @@ -7336,7 +7843,7 @@ type CountAction struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CountAction) String() string { +func (s CreateAPIKeyOutput) String() string { return awsutil.Prettify(s) } @@ -7345,28 +7852,13 @@ func (s CountAction) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CountAction) GoString() string { +func (s CreateAPIKeyOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CountAction) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CountAction"} - if s.CustomRequestHandling != nil { - if err := s.CustomRequestHandling.Validate(); err != nil { - invalidParams.AddNested("CustomRequestHandling", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetCustomRequestHandling sets the CustomRequestHandling field's value. -func (s *CountAction) SetCustomRequestHandling(v *CustomRequestHandling) *CountAction { - s.CustomRequestHandling = v +// SetAPIKey sets the APIKey field's value. +func (s *CreateAPIKeyOutput) SetAPIKey(v string) *CreateAPIKeyOutput { + s.APIKey = &v return s } @@ -10577,6 +11069,120 @@ func (s *GeoMatchStatement) SetForwardedIPConfig(v *ForwardedIPConfig) *GeoMatch return s } +type GetDecryptedAPIKeyInput struct { + _ struct{} `type:"structure"` + + // The encrypted API key. + // + // APIKey is a required field + APIKey *string `min:"1" type:"string" required:"true"` + + // Specifies whether this is for an Amazon CloudFront distribution or for a + // regional application. A regional application can be an Application Load Balancer + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon + // Cognito user pool, or an App Runner service. + // + // To work with CloudFront, you must also specify the Region US East (N. Virginia) + // as follows: + // + // * CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT + // --region=us-east-1. + // + // * API and SDKs - For all calls, use the Region endpoint us-east-1. + // + // Scope is a required field + Scope *string `type:"string" required:"true" enum:"Scope"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDecryptedAPIKeyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDecryptedAPIKeyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetDecryptedAPIKeyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetDecryptedAPIKeyInput"} + if s.APIKey == nil { + invalidParams.Add(request.NewErrParamRequired("APIKey")) + } + if s.APIKey != nil && len(*s.APIKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("APIKey", 1)) + } + if s.Scope == nil { + invalidParams.Add(request.NewErrParamRequired("Scope")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAPIKey sets the APIKey field's value. +func (s *GetDecryptedAPIKeyInput) SetAPIKey(v string) *GetDecryptedAPIKeyInput { + s.APIKey = &v + return s +} + +// SetScope sets the Scope field's value. +func (s *GetDecryptedAPIKeyInput) SetScope(v string) *GetDecryptedAPIKeyInput { + s.Scope = &v + return s +} + +type GetDecryptedAPIKeyOutput struct { + _ struct{} `type:"structure"` + + // The date and time that the key was created. + CreationTimestamp *time.Time `type:"timestamp"` + + // The token domains that are defined in this API key. + TokenDomains []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDecryptedAPIKeyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDecryptedAPIKeyOutput) GoString() string { + return s.String() +} + +// SetCreationTimestamp sets the CreationTimestamp field's value. +func (s *GetDecryptedAPIKeyOutput) SetCreationTimestamp(v time.Time) *GetDecryptedAPIKeyOutput { + s.CreationTimestamp = &v + return s +} + +// SetTokenDomains sets the TokenDomains field's value. +func (s *GetDecryptedAPIKeyOutput) SetTokenDomains(v []*string) *GetDecryptedAPIKeyOutput { + s.TokenDomains = v + return s +} + type GetIPSetInput struct { _ struct{} `type:"structure"` @@ -13239,6 +13845,149 @@ func (s *LabelSummary) SetName(v string) *LabelSummary { return s } +type ListAPIKeysInput struct { + _ struct{} `type:"structure"` + + // The maximum number of objects that you want WAF to return for this request. + // If more objects are available, in the response, WAF provides a NextMarker + // value that you can use in a subsequent call to get the next batch of objects. + Limit *int64 `min:"1" type:"integer"` + + // When you request a list of objects with a Limit setting, if the number of + // objects that are still available for retrieval exceeds the limit, WAF returns + // a NextMarker value in the response. To retrieve the next batch of objects, + // provide the marker from the prior call in your next request. + NextMarker *string `min:"1" type:"string"` + + // Specifies whether this is for an Amazon CloudFront distribution or for a + // regional application. A regional application can be an Application Load Balancer + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon + // Cognito user pool, or an App Runner service. + // + // To work with CloudFront, you must also specify the Region US East (N. Virginia) + // as follows: + // + // * CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT + // --region=us-east-1. + // + // * API and SDKs - For all calls, use the Region endpoint us-east-1. + // + // Scope is a required field + Scope *string `type:"string" required:"true" enum:"Scope"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAPIKeysInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAPIKeysInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAPIKeysInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAPIKeysInput"} + if s.Limit != nil && *s.Limit < 1 { + invalidParams.Add(request.NewErrParamMinValue("Limit", 1)) + } + if s.NextMarker != nil && len(*s.NextMarker) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextMarker", 1)) + } + if s.Scope == nil { + invalidParams.Add(request.NewErrParamRequired("Scope")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLimit sets the Limit field's value. +func (s *ListAPIKeysInput) SetLimit(v int64) *ListAPIKeysInput { + s.Limit = &v + return s +} + +// SetNextMarker sets the NextMarker field's value. +func (s *ListAPIKeysInput) SetNextMarker(v string) *ListAPIKeysInput { + s.NextMarker = &v + return s +} + +// SetScope sets the Scope field's value. +func (s *ListAPIKeysInput) SetScope(v string) *ListAPIKeysInput { + s.Scope = &v + return s +} + +type ListAPIKeysOutput struct { + _ struct{} `type:"structure"` + + // The array of key summaries. If you specified a Limit in your request, this + // might not be the full list. + APIKeySummaries []*APIKeySummary `type:"list"` + + // The CAPTCHA application integration URL, for use in your JavaScript implementation. + // + // For information about how to use this in your CAPTCHA JavaScript integration, + // see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) + // in the WAF Developer Guide. + ApplicationIntegrationURL *string `type:"string"` + + // When you request a list of objects with a Limit setting, if the number of + // objects that are still available for retrieval exceeds the limit, WAF returns + // a NextMarker value in the response. To retrieve the next batch of objects, + // provide the marker from the prior call in your next request. + NextMarker *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAPIKeysOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAPIKeysOutput) GoString() string { + return s.String() +} + +// SetAPIKeySummaries sets the APIKeySummaries field's value. +func (s *ListAPIKeysOutput) SetAPIKeySummaries(v []*APIKeySummary) *ListAPIKeysOutput { + s.APIKeySummaries = v + return s +} + +// SetApplicationIntegrationURL sets the ApplicationIntegrationURL field's value. +func (s *ListAPIKeysOutput) SetApplicationIntegrationURL(v string) *ListAPIKeysOutput { + s.ApplicationIntegrationURL = &v + return s +} + +// SetNextMarker sets the NextMarker field's value. +func (s *ListAPIKeysOutput) SetNextMarker(v string) *ListAPIKeysOutput { + s.NextMarker = &v + return s +} + type ListAvailableManagedRuleGroupVersionsInput struct { _ struct{} `type:"structure"` @@ -13374,7 +14123,8 @@ type ListAvailableManagedRuleGroupVersionsOutput struct { NextMarker *string `min:"1" type:"string"` // The versions that are currently available for the specified managed rule - // group. + // group. If you specified a Limit in your request, this might not be the full + // list. Versions []*ManagedRuleGroupVersion `type:"list"` } @@ -13503,6 +14253,8 @@ func (s *ListAvailableManagedRuleGroupsInput) SetScope(v string) *ListAvailableM type ListAvailableManagedRuleGroupsOutput struct { _ struct{} `type:"structure"` + // Array of managed rule groups that you can use. If you specified a Limit in + // your request, this might not be the full list. ManagedRuleGroups []*ManagedRuleGroupSummary `type:"list"` // When you request a list of objects with a Limit setting, if the number of @@ -13631,8 +14383,8 @@ func (s *ListIPSetsInput) SetScope(v string) *ListIPSetsInput { type ListIPSetsOutput struct { _ struct{} `type:"structure"` - // Array of IPSets. This may not be the full list of IPSets that you have defined. - // See the Limit specification for this request. + // Array of IPSets. If you specified a Limit in your request, this might not + // be the full list. IPSets []*IPSetSummary `type:"list"` // When you request a list of objects with a Limit setting, if the number of @@ -13761,6 +14513,8 @@ func (s *ListLoggingConfigurationsInput) SetScope(v string) *ListLoggingConfigur type ListLoggingConfigurationsOutput struct { _ struct{} `type:"structure"` + // Array of logging configurations. If you specified a Limit in your request, + // this might not be the full list. LoggingConfigurations []*LoggingConfiguration `type:"list"` // When you request a list of objects with a Limit setting, if the number of @@ -13889,7 +14643,8 @@ func (s *ListManagedRuleSetsInput) SetScope(v string) *ListManagedRuleSetsInput type ListManagedRuleSetsOutput struct { _ struct{} `type:"structure"` - // Your managed rule sets. + // Your managed rule sets. If you specified a Limit in your request, this might + // not be the full list. ManagedRuleSets []*ManagedRuleSetSummary `type:"list"` // When you request a list of objects with a Limit setting, if the number of @@ -14013,7 +14768,8 @@ type ListMobileSdkReleasesOutput struct { // provide the marker from the prior call in your next request. NextMarker *string `min:"1" type:"string"` - // High level information for the available SDK releases. + // The high level information for the available SDK releases. If you specified + // a Limit in your request, this might not be the full list. ReleaseSummaries []*ReleaseSummary `type:"list"` } @@ -14142,6 +14898,8 @@ type ListRegexPatternSetsOutput struct { // provide the marker from the prior call in your next request. NextMarker *string `min:"1" type:"string"` + // Array of regex pattern sets. If you specified a Limit in your request, this + // might not be the full list. RegexPatternSets []*RegexPatternSetSummary `type:"list"` } @@ -14365,6 +15123,8 @@ type ListRuleGroupsOutput struct { // provide the marker from the prior call in your next request. NextMarker *string `min:"1" type:"string"` + // Array of rule groups. If you specified a Limit in your request, this might + // not be the full list. RuleGroups []*RuleGroupSummary `type:"list"` } @@ -14485,7 +15245,8 @@ type ListTagsForResourceOutput struct { // provide the marker from the prior call in your next request. NextMarker *string `min:"1" type:"string"` - // The collection of tagging definitions for the resource. + // The collection of tagging definitions for the resource. If you specified + // a Limit in your request, this might not be the full list. TagInfoForResource *TagInfoForResource `type:"structure"` } @@ -14614,6 +15375,8 @@ type ListWebACLsOutput struct { // provide the marker from the prior call in your next request. NextMarker *string `min:"1" type:"string"` + // Array of web ACLs. If you specified a Limit in your request, this might not + // be the full list. WebACLs []*WebACLSummary `type:"list"` } diff --git a/service/wafv2/wafv2iface/interface.go b/service/wafv2/wafv2iface/interface.go index 897031e985..85cde465c6 100644 --- a/service/wafv2/wafv2iface/interface.go +++ b/service/wafv2/wafv2iface/interface.go @@ -68,6 +68,10 @@ type WAFV2API interface { CheckCapacityWithContext(aws.Context, *wafv2.CheckCapacityInput, ...request.Option) (*wafv2.CheckCapacityOutput, error) CheckCapacityRequest(*wafv2.CheckCapacityInput) (*request.Request, *wafv2.CheckCapacityOutput) + CreateAPIKey(*wafv2.CreateAPIKeyInput) (*wafv2.CreateAPIKeyOutput, error) + CreateAPIKeyWithContext(aws.Context, *wafv2.CreateAPIKeyInput, ...request.Option) (*wafv2.CreateAPIKeyOutput, error) + CreateAPIKeyRequest(*wafv2.CreateAPIKeyInput) (*request.Request, *wafv2.CreateAPIKeyOutput) + CreateIPSet(*wafv2.CreateIPSetInput) (*wafv2.CreateIPSetOutput, error) CreateIPSetWithContext(aws.Context, *wafv2.CreateIPSetInput, ...request.Option) (*wafv2.CreateIPSetOutput, error) CreateIPSetRequest(*wafv2.CreateIPSetInput) (*request.Request, *wafv2.CreateIPSetOutput) @@ -124,6 +128,10 @@ type WAFV2API interface { GenerateMobileSdkReleaseUrlWithContext(aws.Context, *wafv2.GenerateMobileSdkReleaseUrlInput, ...request.Option) (*wafv2.GenerateMobileSdkReleaseUrlOutput, error) GenerateMobileSdkReleaseUrlRequest(*wafv2.GenerateMobileSdkReleaseUrlInput) (*request.Request, *wafv2.GenerateMobileSdkReleaseUrlOutput) + GetDecryptedAPIKey(*wafv2.GetDecryptedAPIKeyInput) (*wafv2.GetDecryptedAPIKeyOutput, error) + GetDecryptedAPIKeyWithContext(aws.Context, *wafv2.GetDecryptedAPIKeyInput, ...request.Option) (*wafv2.GetDecryptedAPIKeyOutput, error) + GetDecryptedAPIKeyRequest(*wafv2.GetDecryptedAPIKeyInput) (*request.Request, *wafv2.GetDecryptedAPIKeyOutput) + GetIPSet(*wafv2.GetIPSetInput) (*wafv2.GetIPSetOutput, error) GetIPSetWithContext(aws.Context, *wafv2.GetIPSetInput, ...request.Option) (*wafv2.GetIPSetOutput, error) GetIPSetRequest(*wafv2.GetIPSetInput) (*request.Request, *wafv2.GetIPSetOutput) @@ -168,6 +176,10 @@ type WAFV2API interface { GetWebACLForResourceWithContext(aws.Context, *wafv2.GetWebACLForResourceInput, ...request.Option) (*wafv2.GetWebACLForResourceOutput, error) GetWebACLForResourceRequest(*wafv2.GetWebACLForResourceInput) (*request.Request, *wafv2.GetWebACLForResourceOutput) + ListAPIKeys(*wafv2.ListAPIKeysInput) (*wafv2.ListAPIKeysOutput, error) + ListAPIKeysWithContext(aws.Context, *wafv2.ListAPIKeysInput, ...request.Option) (*wafv2.ListAPIKeysOutput, error) + ListAPIKeysRequest(*wafv2.ListAPIKeysInput) (*request.Request, *wafv2.ListAPIKeysOutput) + ListAvailableManagedRuleGroupVersions(*wafv2.ListAvailableManagedRuleGroupVersionsInput) (*wafv2.ListAvailableManagedRuleGroupVersionsOutput, error) ListAvailableManagedRuleGroupVersionsWithContext(aws.Context, *wafv2.ListAvailableManagedRuleGroupVersionsInput, ...request.Option) (*wafv2.ListAvailableManagedRuleGroupVersionsOutput, error) ListAvailableManagedRuleGroupVersionsRequest(*wafv2.ListAvailableManagedRuleGroupVersionsInput) (*request.Request, *wafv2.ListAvailableManagedRuleGroupVersionsOutput)