Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . servicediscovery ]
Gets information about any operation that returns an operation ID in the response, such as a CreateService
request.
Note
To get a list of operations that match specified criteria, see ListOperations .
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
get-operation
--operation-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--operation-id
(string)
The ID of the operation that you want to get more information about.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
To get the result of an operation
The following get-operation
example gets the result of an operation.
aws servicediscovery get-operation \
--operation-id gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd
Output:
{
"Operation": {
"Id": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
"Type": "CREATE_NAMESPACE",
"Status": "SUCCESS",
"CreateDate": 1587055860.121,
"UpdateDate": 1587055900.469,
"Targets": {
"NAMESPACE": "ns-ylexjili4cdxy3xm"
}
}
}
Operation -> (structure)
A complex type that contains information about the operation.
Id -> (string)
The ID of the operation that you want to get information about.Type -> (string)
The name of the operation that's associated with the specified ID.Status -> (string)
The status of the operation. Values include the following:
SUBMITTEDThis is the initial state that occurs immediately after you submit a request.
PENDINGCloud Map is performing the operation.
SUCCESSThe operation succeeded.
FAILThe operation failed. For the failure reason, see
ErrorMessage
.ErrorMessage -> (string)
If the value ofStatus
isFAIL
, the reason that the operation failed.ErrorCode -> (string)
The code associated with
ErrorMessage
. Values forErrorCode
include the following:
ACCESS_DENIED
CANNOT_CREATE_HOSTED_ZONE
EXPIRED_TOKEN
HOSTED_ZONE_NOT_FOUND
INTERNAL_FAILURE
INVALID_CHANGE_BATCH
THROTTLED_REQUEST
CreateDate -> (timestamp)
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value ofCreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.UpdateDate -> (timestamp)
The date and time that the value ofStatus
changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value ofUpdateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.Targets -> (map)
The name of the target entity that's associated with the operation:
NAMESPACEThe namespace ID is returned in the
ResourceId
property.SERVICEThe service ID is returned in the
ResourceId
property.INSTANCEThe instance ID is returned in the
ResourceId
property.key -> (string)
value -> (string)