From 2948a9b947de919a06a574cd561c086343efa593 Mon Sep 17 00:00:00 2001 From: aws-sdk-go-automation <43143561+aws-sdk-go-automation@users.noreply.github.com> Date: Thu, 13 Jan 2022 11:21:43 -0800 Subject: [PATCH] Release v1.42.34 (2022-01-13) (#4240) Release v1.42.34 (2022-01-13) === ### Service Client Updates * `service/elasticache`: Updates service API and documentation * AWS ElastiCache for Redis has added a new Engine Log LogType in LogDelivery feature. You can now publish the Engine Log from your Amazon ElastiCache for Redis clusters to Amazon CloudWatch Logs and Amazon Kinesis Data Firehose. * `service/glue`: Updates service API and documentation * This SDK release adds support to pass run properties when starting a workflow run * `service/nimble`: Updates service API and documentation * `service/pinpoint`: Updates service API * Adds JourneyChannelSettings to WriteJourneyRequest * `service/runtime.lex.v2`: Updates service API and documentation * `service/ssm`: Updates service API and documentation * AWS Systems Manager adds category support for DescribeDocument API --- CHANGELOG.md | 15 + aws/endpoints/defaults.go | 21 ++ aws/version.go | 2 +- models/apis/elasticache/2015-02-02/api-2.json | 5 +- .../apis/elasticache/2015-02-02/docs-2.json | 6 +- models/apis/glue/2017-03-31/api-2.json | 3 +- models/apis/glue/2017-03-31/docs-2.json | 1 + models/apis/nimble/2020-08-01/api-2.json | 77 ++++- models/apis/nimble/2020-08-01/docs-2.json | 80 ++++- models/apis/pinpoint/2016-12-01/api-2.json | 84 ++--- .../apis/runtime.lex.v2/2020-08-07/api-2.json | 50 ++- .../runtime.lex.v2/2020-08-07/docs-2.json | 51 ++- models/apis/ssm/2014-11-06/api-2.json | 20 +- models/apis/ssm/2014-11-06/docs-2.json | 43 ++- models/endpoints/endpoints.json | 14 + service/elasticache/api.go | 10 +- service/glue/api.go | 9 + service/lexruntimev2/api.go | 130 ++++++++ service/lexruntimev2/eventstream_test.go | 254 +++++++++++++++ service/nimblestudio/api.go | 196 ++++++++++- service/pinpoint/api.go | 303 ++++++++++++++++++ service/pinpoint/pinpointiface/interface.go | 4 + service/ssm/api.go | 73 ++++- service/ssm/doc.go | 2 +- 24 files changed, 1347 insertions(+), 106 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 005c7ef9780..0fb37c19747 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +Release v1.42.34 (2022-01-13) +=== + +### Service Client Updates +* `service/elasticache`: Updates service API and documentation + * AWS ElastiCache for Redis has added a new Engine Log LogType in LogDelivery feature. You can now publish the Engine Log from your Amazon ElastiCache for Redis clusters to Amazon CloudWatch Logs and Amazon Kinesis Data Firehose. +* `service/glue`: Updates service API and documentation + * This SDK release adds support to pass run properties when starting a workflow run +* `service/nimble`: Updates service API and documentation +* `service/pinpoint`: Updates service API + * Adds JourneyChannelSettings to WriteJourneyRequest +* `service/runtime.lex.v2`: Updates service API and documentation +* `service/ssm`: Updates service API and documentation + * AWS Systems Manager adds category support for DescribeDocument API + Release v1.42.33 (2022-01-12) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index bdc1a51f488..c63e8b4ec5c 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -2562,6 +2562,9 @@ var awsPartition = partition{ endpointKey{ Region: "ap-southeast-2", }: endpoint{}, + endpointKey{ + Region: "ap-southeast-3", + }: endpoint{}, endpointKey{ Region: "ca-central-1", }: endpoint{}, @@ -28021,6 +28024,24 @@ var awsisoPartition = partition{ }, Deprecated: boxedTrue, }, + endpointKey{ + Region: "us-iso-west-1", + }: endpoint{}, + endpointKey{ + Region: "us-iso-west-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "dms.us-iso-west-1.c2s.ic.gov", + }, + endpointKey{ + Region: "us-iso-west-1-fips", + }: endpoint{ + Hostname: "dms.us-iso-west-1.c2s.ic.gov", + CredentialScope: credentialScope{ + Region: "us-iso-west-1", + }, + Deprecated: boxedTrue, + }, }, }, "ds": service{ diff --git a/aws/version.go b/aws/version.go index 5d0766e1688..81897e27c95 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.42.33" +const SDKVersion = "1.42.34" diff --git a/models/apis/elasticache/2015-02-02/api-2.json b/models/apis/elasticache/2015-02-02/api-2.json index f4f90d98562..92c5db20658 100644 --- a/models/apis/elasticache/2015-02-02/api-2.json +++ b/models/apis/elasticache/2015-02-02/api-2.json @@ -3053,7 +3053,10 @@ }, "LogType":{ "type":"string", - "enum":["slow-log"] + "enum":[ + "slow-log", + "engine-log" + ] }, "ModifyCacheClusterMessage":{ "type":"structure", diff --git a/models/apis/elasticache/2015-02-02/docs-2.json b/models/apis/elasticache/2015-02-02/docs-2.json index 27ee921bfe4..734ac4e9ff0 100644 --- a/models/apis/elasticache/2015-02-02/docs-2.json +++ b/models/apis/elasticache/2015-02-02/docs-2.json @@ -1303,9 +1303,9 @@ "LogType": { "base": null, "refs": { - "LogDeliveryConfiguration$LogType": "
Refers to slow-log.
", - "LogDeliveryConfigurationRequest$LogType": "Refers to slow-log.
", - "PendingLogDeliveryConfiguration$LogType": "Refers to slow-log.
" + "LogDeliveryConfiguration$LogType": "Refers to slow-log or engine-log.
", + "LogDeliveryConfigurationRequest$LogType": "Refers to slow-log or engine-log..
", + "PendingLogDeliveryConfiguration$LogType": "Refers to slow-log or engine-log..
" } }, "ModifyCacheClusterMessage": { diff --git a/models/apis/glue/2017-03-31/api-2.json b/models/apis/glue/2017-03-31/api-2.json index 47f732890bc..a747984fa66 100644 --- a/models/apis/glue/2017-03-31/api-2.json +++ b/models/apis/glue/2017-03-31/api-2.json @@ -7890,7 +7890,8 @@ "type":"structure", "required":["Name"], "members":{ - "Name":{"shape":"NameString"} + "Name":{"shape":"NameString"}, + "RunProperties":{"shape":"WorkflowRunProperties"} } }, "StartWorkflowRunResponse":{ diff --git a/models/apis/glue/2017-03-31/docs-2.json b/models/apis/glue/2017-03-31/docs-2.json index c55ae05b5ab..4b2e7947ee7 100644 --- a/models/apis/glue/2017-03-31/docs-2.json +++ b/models/apis/glue/2017-03-31/docs-2.json @@ -6054,6 +6054,7 @@ "CreateWorkflowRequest$DefaultRunProperties": "A collection of properties to be used as part of each execution of the workflow.
", "GetWorkflowRunPropertiesResponse$RunProperties": "The workflow run properties which were set during the specified run.
", "PutWorkflowRunPropertiesRequest$RunProperties": "The properties to put for the specified run.
", + "StartWorkflowRunRequest$RunProperties": "The workflow run properties for the new workflow run.
", "UpdateWorkflowRequest$DefaultRunProperties": "A collection of properties to be used as part of each execution of the workflow.
", "Workflow$DefaultRunProperties": "A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
", "WorkflowRun$WorkflowRunProperties": "The workflow run properties which were set during the run.
" diff --git a/models/apis/nimble/2020-08-01/api-2.json b/models/apis/nimble/2020-08-01/api-2.json index b8d94ff6c2b..012333718d7 100644 --- a/models/apis/nimble/2020-08-01/api-2.json +++ b/models/apis/nimble/2020-08-01/api-2.json @@ -1820,7 +1820,8 @@ "studioComponentIds":{"shape":"LaunchProfileStudioComponentIdList"}, "tags":{"shape":"Tags"}, "updatedAt":{"shape":"Timestamp"}, - "updatedBy":{"shape":"String"} + "updatedBy":{"shape":"String"}, + "validationResults":{"shape":"ValidationResults"} } }, "LaunchProfileDescription":{ @@ -1937,6 +1938,10 @@ "UPDATE_FAILED" ] }, + "LaunchProfileStateList":{ + "type":"list", + "member":{"shape":"LaunchProfileState"} + }, "LaunchProfileStatusCode":{ "type":"string", "enum":[ @@ -1961,6 +1966,40 @@ "max":100, "min":1 }, + "LaunchProfileValidationState":{ + "type":"string", + "enum":[ + "VALIDATION_NOT_STARTED", + "VALIDATION_IN_PROGRESS", + "VALIDATION_SUCCESS", + "VALIDATION_FAILED", + "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" + ] + }, + "LaunchProfileValidationStatusCode":{ + "type":"string", + "enum":[ + "VALIDATION_NOT_STARTED", + "VALIDATION_IN_PROGRESS", + "VALIDATION_SUCCESS", + "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION", + "VALIDATION_FAILED_SUBNET_NOT_FOUND", + "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION", + "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY", + "VALIDATION_FAILED_UNAUTHORIZED", + "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" + ] + }, + "LaunchProfileValidationStatusMessage":{"type":"string"}, + "LaunchProfileValidationType":{ + "type":"string", + "enum":[ + "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT", + "VALIDATE_SUBNET_ASSOCIATION", + "VALIDATE_NETWORK_ACL_ASSOCIATION", + "VALIDATE_SECURITY_GROUP_ASSOCIATION" + ] + }, "LaunchPurpose":{ "type":"string", "max":64, @@ -2086,7 +2125,7 @@ "locationName":"principalId" }, "states":{ - "shape":"StringList", + "shape":"LaunchProfileStateList", "location":"querystring", "locationName":"states" }, @@ -2185,7 +2224,7 @@ "locationName":"nextToken" }, "states":{ - "shape":"StringList", + "shape":"StudioComponentStateList", "location":"querystring", "locationName":"states" }, @@ -2195,7 +2234,7 @@ "locationName":"studioId" }, "types":{ - "shape":"StringList", + "shape":"StudioComponentTypeList", "location":"querystring", "locationName":"types" } @@ -2737,7 +2776,8 @@ "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", - "STREAMING_SESSION_START_IN_PROGRESS" + "STREAMING_SESSION_START_IN_PROGRESS", + "AMI_VALIDATION_ERROR" ] }, "StreamingSessionStorageMode":{ @@ -2945,6 +2985,10 @@ "UPDATE_FAILED" ] }, + "StudioComponentStateList":{ + "type":"list", + "member":{"shape":"StudioComponentState"} + }, "StudioComponentStatusCode":{ "type":"string", "enum":[ @@ -2997,6 +3041,10 @@ "CUSTOM" ] }, + "StudioComponentTypeList":{ + "type":"list", + "member":{"shape":"StudioComponentType"} + }, "StudioEncryptionConfiguration":{ "type":"structure", "required":["keyType"], @@ -3403,6 +3451,25 @@ }, "exception":true }, + "ValidationResult":{ + "type":"structure", + "required":[ + "state", + "statusCode", + "statusMessage", + "type" + ], + "members":{ + "state":{"shape":"LaunchProfileValidationState"}, + "statusCode":{"shape":"LaunchProfileValidationStatusCode"}, + "statusMessage":{"shape":"LaunchProfileValidationStatusMessage"}, + "type":{"shape":"LaunchProfileValidationType"} + } + }, + "ValidationResults":{ + "type":"list", + "member":{"shape":"ValidationResult"} + }, "WindowsMountDrive":{ "type":"string", "pattern":"^[A-Z]$" diff --git a/models/apis/nimble/2020-08-01/docs-2.json b/models/apis/nimble/2020-08-01/docs-2.json index 799d267e407..cda382686a5 100644 --- a/models/apis/nimble/2020-08-01/docs-2.json +++ b/models/apis/nimble/2020-08-01/docs-2.json @@ -22,7 +22,7 @@ "GetLaunchProfileInitialization": "Get a launch profile initialization.
", "GetLaunchProfileMember": "Get a user persona in launch profile membership.
", "GetStreamingImage": "Get streaming image.
", - "GetStreamingSession": "Gets StreamingSession resource.
anvoke this operation to poll for a streaming session state while creating or deleting a session.
", + "GetStreamingSession": "Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
", "GetStreamingSessionStream": "Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.
After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.
", "GetStudio": "Get a Studio resource.
", "GetStudioComponent": "Gets a studio component resource.
", @@ -612,7 +612,14 @@ "LaunchProfileState": { "base": null, "refs": { - "LaunchProfile$state": "The current state.
" + "LaunchProfile$state": "The current state.
", + "LaunchProfileStateList$member": null + } + }, + "LaunchProfileStateList": { + "base": null, + "refs": { + "ListLaunchProfilesRequest$states": "Filter this request to launch profiles in any of the given states.
" } }, "LaunchProfileStatusCode": { @@ -629,6 +636,30 @@ "UpdateLaunchProfileRequest$studioComponentIds": "Unique identifiers for a collection of studio components that can be used with this launch profile.
" } }, + "LaunchProfileValidationState": { + "base": null, + "refs": { + "ValidationResult$state": "The current state.
" + } + }, + "LaunchProfileValidationStatusCode": { + "base": null, + "refs": { + "ValidationResult$statusCode": "The status code. This will contain the failure reason if the state is VALIDATION_FAILED
.
The status message for the validation result.
" + } + }, + "LaunchProfileValidationType": { + "base": null, + "refs": { + "ValidationResult$type": "The type of the validation result.
" + } + }, "LaunchPurpose": { "base": "The launch purpose.
", "refs": { @@ -900,8 +931,8 @@ "StreamConfigurationMaxStoppedSessionLengthInMinutes": { "base": null, "refs": { - "StreamConfiguration$maxStoppedSessionLengthInMinutes": "Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
", - "StreamConfigurationCreate$maxStoppedSessionLengthInMinutes": "Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
" + "StreamConfiguration$maxStoppedSessionLengthInMinutes": "Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession
, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes
value, the session will automatically be terminated by AWS (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession
to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes
value, the session will automatically be stopped by AWS (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession
, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes
value, the session will automatically be terminated by AWS (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession
to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes
value, the session will automatically be stopped by AWS (instead of terminated).
The folder path in Linux workstations where files are uploaded. The default path is $HOME/Downloads
.
The folder path in Linux workstations where files are uploaded.
" } }, "StreamingSessionStorageRootPathWindows": { "base": null, "refs": { - "StreamingSessionStorageRoot$windows": "The folder path in Windows workstations where files are uploaded. The default path is %HOMEPATH%\\Downloads
.
The folder path in Windows workstations where files are uploaded.
" } }, "StreamingSessionStream": { @@ -1109,7 +1140,7 @@ "CreateLaunchProfileRequest$studioId": "The studio ID.
", "CreateStreamingImageRequest$studioId": "The studio ID.
", "CreateStreamingSessionRequest$launchProfileId": "The launch profile ID.
", - "CreateStreamingSessionRequest$ownedBy": "The user ID of the user that owns the streaming session.
", + "CreateStreamingSessionRequest$ownedBy": "The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
", "CreateStreamingSessionRequest$studioId": "The studio ID.
", "CreateStreamingSessionStreamRequest$sessionId": "The streaming session ID.
", "CreateStreamingSessionStreamRequest$studioId": "The studio ID.
", @@ -1226,13 +1257,13 @@ "StreamingSession$createdBy": "The user ID of the user that created the streaming session.
", "StreamingSession$ec2InstanceType": "The EC2 Instance type used for the streaming session.
", "StreamingSession$launchProfileId": "The ID of the launch profile used to control access from the streaming session.
", - "StreamingSession$ownedBy": "The user ID of the user that owns the streaming session.
", + "StreamingSession$ownedBy": "The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
", "StreamingSession$startedBy": "The user ID of the user that started the streaming session.
", "StreamingSession$statusMessage": "The status message for the streaming session.
", "StreamingSession$stoppedBy": "The user ID of the user that stopped the streaming session.
", "StreamingSession$updatedBy": "The user ID of the user that most recently updated the resource.
", "StreamingSessionStream$createdBy": "The user ID of the user that created the streaming session stream.
", - "StreamingSessionStream$ownedBy": "The user ID of the user that owns the streaming session.
", + "StreamingSessionStream$ownedBy": "The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
", "StreamingSessionStream$streamId": "The stream ID.
", "StringList$member": null, "Studio$adminRoleArn": "The IAM role that studio admins assume when logging in to the Nimble Studio portal.
", @@ -1279,9 +1310,6 @@ "GetLaunchProfileInitializationRequest$launchProfileProtocolVersions": "The launch profile protocol versions supported by the client.
", "ListEulaAcceptancesRequest$eulaIds": "The list of EULA IDs that have been previously accepted.
", "ListEulasRequest$eulaIds": "The list of EULA IDs that should be returned
", - "ListLaunchProfilesRequest$states": "Filter this request to launch profiles in any of the given states.
", - "ListStudioComponentsRequest$states": "Filters the request to studio components that are in one of the given states.
", - "ListStudioComponentsRequest$types": "Filters the request to studio components that are of one of the given types.
", "UntagResourceRequest$tagKeys": "One or more tag keys. Specify only the tag keys, not the tag values.
" } }, @@ -1395,7 +1423,14 @@ "StudioComponentState": { "base": "The current state of the studio component resource.
While a studio component is being created, modified, or deleted, its state will equal \"CREATE_IN_PROGRESS\", \"UPDATE_IN_PROGRESS\", or \"DELETE_IN_PROGRESS\"
These are called 'transition states'.
No modifications may be made to the studio component while it is in a transition state.
If creation of the resource fails, the state will change to `CREATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why creation failed. The resource in this state will automatically be deleted from your account after a period of time.
If updating the resource fails, the state will change to `UPDATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked.
If deleting the resource fails, the state will change to `DELETE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked. After the resource is deleted successfully, it will change to the \"DELETED\" state. The resource will no longer count against service quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.
", "refs": { - "StudioComponent$state": "The current state.
" + "StudioComponent$state": "The current state.
", + "StudioComponentStateList$member": null + } + }, + "StudioComponentStateList": { + "base": null, + "refs": { + "ListStudioComponentsRequest$states": "Filters the request to studio components that are in one of the given states.
" } }, "StudioComponentStatusCode": { @@ -1431,9 +1466,16 @@ "CreateStudioComponentRequest$type": "The type of the studio component.
", "StudioComponent$type": "The type of the studio component.
", "StudioComponentSummary$type": "The type of the studio component.
", + "StudioComponentTypeList$member": null, "UpdateStudioComponentRequest$type": "The type of the studio component.
" } }, + "StudioComponentTypeList": { + "base": null, + "refs": { + "ListStudioComponentsRequest$types": "Filters the request to studio components that are of one of the given types.
" + } + }, "StudioEncryptionConfiguration": { "base": "Configuration of the encryption method that is used for the studio.
", "refs": { @@ -1698,6 +1740,18 @@ "refs": { } }, + "ValidationResult": { + "base": "The launch profile validation result.
", + "refs": { + "ValidationResults$member": null + } + }, + "ValidationResults": { + "base": null, + "refs": { + "LaunchProfile$validationResults": "The list of the latest validation results.
" + } + }, "WindowsMountDrive": { "base": null, "refs": { diff --git a/models/apis/pinpoint/2016-12-01/api-2.json b/models/apis/pinpoint/2016-12-01/api-2.json index c68a592790d..d75ed8fdc22 100644 --- a/models/apis/pinpoint/2016-12-01/api-2.json +++ b/models/apis/pinpoint/2016-12-01/api-2.json @@ -4271,44 +4271,44 @@ "shape": "TooManyRequestsException" } ] - } - }, - "VerifyOTPMessage": { - "name": "VerifyOTPMessage", - "http": { - "method": "POST", - "requestUri": "/v1/apps/{application-id}/verify-otp", - "responseCode": 200 - }, - "input": { - "shape": "VerifyOTPMessageRequest" - }, - "output": { - "shape": "VerifyOTPMessageResponse" }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "PayloadTooLargeException" - }, - { - "shape": "ForbiddenException" + "VerifyOTPMessage": { + "name": "VerifyOTPMessage", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/verify-otp", + "responseCode": 200 }, - { - "shape": "NotFoundException" + "input": { + "shape": "VerifyOTPMessageRequest" }, - { - "shape": "MethodNotAllowedException" + "output": { + "shape": "VerifyOTPMessageResponse" }, - { - "shape": "TooManyRequestsException" - } - ] + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "PayloadTooLargeException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "MethodNotAllowedException" + }, + { + "shape": "TooManyRequestsException" + } + ] + } }, "shapes": { "ADMChannelRequest": { @@ -12699,14 +12699,14 @@ "type": "structure", "members": { "DestinationIdentity": { - "shape": "__string" - }, - "Otp": { - "shape": "__string" - }, - "ReferenceId": { - "shape": "__string" - } + "shape": "__string" + }, + "Otp": { + "shape": "__string" + }, + "ReferenceId": { + "shape": "__string" + } }, "required": [ "ReferenceId", diff --git a/models/apis/runtime.lex.v2/2020-08-07/api-2.json b/models/apis/runtime.lex.v2/2020-08-07/api-2.json index 53c082e0e0e..3af9dd76226 100644 --- a/models/apis/runtime.lex.v2/2020-08-07/api-2.json +++ b/models/apis/runtime.lex.v2/2020-08-07/api-2.json @@ -557,6 +557,12 @@ "member":{"shape":"Message"}, "max":10 }, + "Name":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([0-9a-zA-Z][_-]?)+$" + }, "NonEmptyString":{ "type":"string", "min":1 @@ -818,6 +824,37 @@ "error":{"httpStatusCode":404}, "exception":true }, + "RuntimeHintDetails":{ + "type":"structure", + "required":["runtimeHintValues"], + "members":{ + "runtimeHintValues":{"shape":"RuntimeHintValuesList"} + } + }, + "RuntimeHintPhrase":{ + "type":"string", + "max":140, + "min":1 + }, + "RuntimeHintValue":{ + "type":"structure", + "required":["phrase"], + "members":{ + "phrase":{"shape":"RuntimeHintPhrase"} + } + }, + "RuntimeHintValuesList":{ + "type":"list", + "member":{"shape":"RuntimeHintValue"}, + "max":100, + "min":1 + }, + "RuntimeHints":{ + "type":"structure", + "members":{ + "slotHints":{"shape":"SlotHintsIntentMap"} + } + }, "SensitiveNonEmptyString":{ "type":"string", "sensitive":true @@ -860,7 +897,8 @@ "intent":{"shape":"Intent"}, "activeContexts":{"shape":"ActiveContextsList"}, "sessionAttributes":{"shape":"StringMap"}, - "originatingRequestId":{"shape":"NonEmptyString"} + "originatingRequestId":{"shape":"NonEmptyString"}, + "runtimeHints":{"shape":"RuntimeHints"} } }, "Shape":{ @@ -878,6 +916,16 @@ "values":{"shape":"Values"} } }, + "SlotHintsIntentMap":{ + "type":"map", + "key":{"shape":"Name"}, + "value":{"shape":"SlotHintsSlotMap"} + }, + "SlotHintsSlotMap":{ + "type":"map", + "key":{"shape":"Name"}, + "value":{"shape":"RuntimeHintDetails"} + }, "Slots":{ "type":"map", "key":{"shape":"NonEmptyString"}, diff --git a/models/apis/runtime.lex.v2/2020-08-07/docs-2.json b/models/apis/runtime.lex.v2/2020-08-07/docs-2.json index ee9164a9753..e4e503b6816 100644 --- a/models/apis/runtime.lex.v2/2020-08-07/docs-2.json +++ b/models/apis/runtime.lex.v2/2020-08-07/docs-2.json @@ -374,6 +374,13 @@ "TextResponseEvent$messages": "A list of messages to send to the user. Messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
" } }, + "Name": { + "base": null, + "refs": { + "SlotHintsIntentMap$key": null, + "SlotHintsSlotMap$key": null + } + }, "NonEmptyString": { "base": null, "refs": { @@ -397,7 +404,7 @@ "RecognizeUtteranceResponse$sessionState": "Represents the current state of the dialog between the user and the bot.
Use this to determine the progress of the conversation and what the next action might be.
The sessionState
field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
The attributes sent in the request.
The requestAttributes
field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
The text used to process the request.
If the input was an audio stream, the inputTranscript
field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
The inputTranscript
field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
A unique identifier for a specific request.
", "Slots$key": null, "StringList$member": null, "StringMap$key": null, @@ -465,6 +472,36 @@ "StartConversationResponseEventStream$ResourceNotFoundException": "Exception thrown if one of the input parameters points to a resource that does not exist. For example, if the bot ID specified does not exist.
" } }, + "RuntimeHintDetails": { + "base": "Provides an array of phrases that should be given preference when resolving values for a slot.
", + "refs": { + "SlotHintsSlotMap$value": null + } + }, + "RuntimeHintPhrase": { + "base": null, + "refs": { + "RuntimeHintValue$phrase": "The phrase that Amazon Lex V2 should look for in the user's input to the bot.
" + } + }, + "RuntimeHintValue": { + "base": "Provides the phrase that Amazon Lex V2 should look for in the user's input to the bot.
", + "refs": { + "RuntimeHintValuesList$member": null + } + }, + "RuntimeHintValuesList": { + "base": null, + "refs": { + "RuntimeHintDetails$runtimeHintValues": "One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.
" + } + }, + "RuntimeHints": { + "base": "You can provide Amazon Lex V2 with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.
Before you can use runtime hints with an existing bot, you must first rebuild the bot.
For more information, see Using hints to improve accuracy.
", + "refs": { + "SessionState$runtimeHints": "Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.
" + } + }, "SensitiveNonEmptyString": { "base": null, "refs": { @@ -530,6 +567,18 @@ "Values$member": null } }, + "SlotHintsIntentMap": { + "base": null, + "refs": { + "RuntimeHints$slotHints": "A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
The first level of the slotHints
map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.
The intent name and slot name must exist.
" + } + }, + "SlotHintsSlotMap": { + "base": null, + "refs": { + "SlotHintsIntentMap$value": null + } + }, "Slots": { "base": null, "refs": { diff --git a/models/apis/ssm/2014-11-06/api-2.json b/models/apis/ssm/2014-11-06/api-2.json index c66f08e072b..c0fd3430427 100644 --- a/models/apis/ssm/2014-11-06/api-2.json +++ b/models/apis/ssm/2014-11-06/api-2.json @@ -2845,6 +2845,22 @@ "WindowExecutionId":{"shape":"MaintenanceWindowExecutionId"} } }, + "Category":{ + "type":"string", + "max":128 + }, + "CategoryEnumList":{ + "type":"list", + "member":{"shape":"Category"}, + "max":3, + "min":0 + }, + "CategoryList":{ + "type":"list", + "member":{"shape":"Category"}, + "max":3, + "min":0 + }, "ChangeDetailsValue":{ "type":"string", "max":32768, @@ -4448,7 +4464,9 @@ "ReviewInformation":{"shape":"ReviewInformationList"}, "ApprovedVersion":{"shape":"DocumentVersion"}, "PendingReviewVersion":{"shape":"DocumentVersion"}, - "ReviewStatus":{"shape":"ReviewStatus"} + "ReviewStatus":{"shape":"ReviewStatus"}, + "Category":{"shape":"CategoryList"}, + "CategoryEnum":{"shape":"CategoryEnumList"} } }, "DocumentDisplayName":{ diff --git a/models/apis/ssm/2014-11-06/docs-2.json b/models/apis/ssm/2014-11-06/docs-2.json index 5a025b86cea..a448b9e2314 100644 --- a/models/apis/ssm/2014-11-06/docs-2.json +++ b/models/apis/ssm/2014-11-06/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or virtual machine (VM) that has been configured for Systems Manager.
With support for IoT Greengrass Version 2 devices, the phrase managed instance has been changed to managed node in most of the Systems Manager documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the term instance.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
To get started, verify prerequisites and configure managed nodes. For more information, see Setting up Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
Related resources
For information about how to use a Query API, see Making API requests.
For information about other API operations you can perform on EC2 instances, see the Amazon EC2 API Reference.
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference.
For information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide and the Incident Manager API Reference.
Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or virtual machine (VM) that has been configured for Systems Manager.
With support for IoT Greengrass core devices, the phrase managed instance has been changed to managed node in most of the Systems Manager documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the term instance.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
To get started, verify prerequisites and configure managed nodes. For more information, see Setting up Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
Related resources
For information about how to use a Query API, see Making API requests.
For information about other API operations you can perform on EC2 instances, see the Amazon EC2 API Reference.
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference.
For information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide and the Incident Manager API Reference.
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
", "AssociateOpsItemRelatedItem": "Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
", @@ -123,7 +123,7 @@ "StopAutomationExecution": "Stop an Automation that is currently running.
", "TerminateSession": "Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session isn't be resumed.
", "UnlabelParameterVersion": "Remove a label or labels from a parameter.
", - "UpdateAssociation": "Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output.
In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation
, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation
, the system drops all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name
parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation
call.
In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation
, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval
parameter to run the association during the next schedule run.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus
is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId
legacy parameter.
Updates one or more values for an SSM document.
", "UpdateDocumentDefaultVersion": "Set the default version of a document.
", @@ -966,6 +966,25 @@ "refs": { } }, + "Category": { + "base": null, + "refs": { + "CategoryEnumList$member": null, + "CategoryList$member": null + } + }, + "CategoryEnumList": { + "base": null, + "refs": { + "DocumentDescription$CategoryEnum": "The value that identifies a document's category.
" + } + }, + "CategoryList": { + "base": null, + "refs": { + "DocumentDescription$Category": "The classification of a document to help you identify and categorize its use.
" + } + }, "ChangeDetailsValue": { "base": null, "refs": { @@ -1138,7 +1157,7 @@ "CompletedCount": { "base": null, "refs": { - "Command$CompletedCount": "The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
" + "Command$CompletedCount": "The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
" } }, "ComplianceExecutionId": { @@ -2147,7 +2166,7 @@ } }, "DocumentDescription": { - "base": "Describes a Amazon Web Services Systems Manager document (SSM document).
", + "base": "Describes an Amazon Web Services Systems Manager document (SSM document).
", "refs": { "CreateDocumentResult$DocumentDescription": "Information about the SSM document.
", "DescribeDocumentResult$Document": "Information about the SSM document.
", @@ -2464,7 +2483,7 @@ "DocumentVersion": { "base": null, "refs": { - "Association$DocumentVersion": "The version of the document used in the association.
", + "Association$DocumentVersion": "The version of the document used in the association.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default
.
The document version.
", "AssociationVersionInfo$DocumentVersion": "The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
", "AutomationExecution$DocumentVersion": "The version of the document to use during execution.
", @@ -2472,7 +2491,7 @@ "Command$DocumentVersion": "The Systems Manager document (SSM document) version.
", "CommandInvocation$DocumentVersion": "The Systems Manager document (SSM document) version.
", "CreateAssociationBatchRequestEntry$DocumentVersion": "The document version.
", - "CreateAssociationRequest$DocumentVersion": "The document version you want to associate with the target(s). Can be a specific version or the default version.
", + "CreateAssociationRequest$DocumentVersion": "The document version you want to associate with the target(s). Can be a specific version or the default version.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default
.
The version of the document that you want to delete. If not provided, all versions of the document are deleted.
", "DescribeDocumentRequest$DocumentVersion": "The document version for which you want information. Can be a specific version or the default version.
", "DocumentDefaultVersionDescription$DefaultVersion": "The default version of the document.
", @@ -2496,7 +2515,7 @@ "SendCommandRequest$DocumentVersion": "The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version \"\\$DEFAULT\"
--document-version \"\\$LATEST\"
--document-version \"3\"
", "StartAutomationExecutionRequest$DocumentVersion": "The version of the Automation runbook to use for this execution.
", "StartChangeRequestExecutionRequest$DocumentVersion": "The version of the change template document to run during the runbook workflow.
", - "UpdateAssociationRequest$DocumentVersion": "The document version you want update for the association.
", + "UpdateAssociationRequest$DocumentVersion": "The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default
.
The version of a change template in which to update approval metadata.
", "UpdateDocumentRequest$DocumentVersion": "The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST
variable.
The list of OS platforms compatible with this SSM document.
", + "DocumentDescription$PlatformTypes": "The list of operating system (OS) platforms compatible with this SSM document.
", "DocumentIdentifier$PlatformTypes": "The operating system platform.
" } }, @@ -7280,10 +7299,10 @@ "StatusDetails": { "base": null, "refs": { - "Command$StatusDetails": "A detailed status of the command execution. StatusDetails
includes more information than Status
because it includes states resulting from error and concurrency control parameters. StatusDetails
can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
A detailed status of the command execution for each invocation (each managed node targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The managed node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the plugin execution. StatusDetails
includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the command execution for an invocation. StatusDetails
includes more information than Status
because it includes states resulting from error and concurrency control parameters. StatusDetails
can show different results than Status
. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails
can be one of the following values:
Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.
Success: The command or plugin ran successfully. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors
limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors
limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the command execution. StatusDetails
includes more information than Status
because it includes states resulting from error and concurrency control parameters. StatusDetails
can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
A detailed status of the command execution for each invocation (each managed node targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The managed node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the plugin execution. StatusDetails
includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
A detailed status of the command execution for an invocation. StatusDetails
includes more information than Status
because it includes states resulting from error and concurrency control parameters. StatusDetails
can show different results than Status
. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails
can be one of the following values:
Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.
Success: The command or plugin ran successfully. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors
limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors
limit and subsequent command invocations were canceled by the system. This is a terminal state.