[ 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
get-operation
--operation-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--operation-id
(string)
The ID of the operation that you want to get more information about.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
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:
SUBMITTED
This is the initial state that occurs immediately after you submit a request.
PENDING
Cloud Map is performing the operation.
SUCCESS
The operation succeeded.
FAIL
The operation failed. For the failure reason, see
ErrorMessage
.ErrorMessage -> (string)
If the value of
Status
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 of
CreateDate
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 of
Status
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:
NAMESPACE
The namespace ID is returned in the
ResourceId
property.SERVICE
The service ID is returned in the
ResourceId
property.INSTANCE
The instance ID is returned in the
ResourceId
property.key -> (string)
value -> (string)