ServiceDiscovery / Client / list_operations
list_operations#
- ServiceDiscovery.Client.list_operations(**kwargs)#
Lists operations that match the criteria that you specify.
See also: AWS API Documentation
Request Syntax
response = client.list_operations( NextToken='string', MaxResults=123, Filters=[ { 'Name': 'NAMESPACE_ID'|'SERVICE_ID'|'STATUS'|'TYPE'|'UPDATE_DATE', 'Values': [ 'string', ], 'Condition': 'EQ'|'IN'|'BETWEEN'|'BEGINS_WITH' }, ] )
- Parameters:
NextToken (string) –
For the first
ListOperations
request, omit this value.If the response contains
NextToken
, submit anotherListOperations
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note
Cloud Map gets
MaxResults
operations and then filters them based on the specified criteria. It’s possible that no operations in the firstMaxResults
operations matched the specified criteria but that subsequent groups ofMaxResults
operations do contain operations that match the criteria.MaxResults (integer) – The maximum number of items that you want Cloud Map to return in the response to a
ListOperations
request. If you don’t specify a value forMaxResults
, Cloud Map returns up to 100 operations.Filters (list) –
A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.
If you specify more than one filter, an operation must match all filters to be returned by
ListOperations
.(dict) –
A complex type that lets you select the operations that you want to list.
Name (string) – [REQUIRED]
Specify the operations that you want to get:
NAMESPACE_ID: Gets operations related to specified namespaces.
SERVICE_ID: Gets operations related to specified services.
STATUS: Gets operations based on the status of the operations:
SUBMITTED
,PENDING
,SUCCEED
, orFAIL
.TYPE: Gets specified types of operation.
UPDATE_DATE: Gets operations that changed status during a specified date/time range.
Values (list) – [REQUIRED]
Specify values that are applicable to the value that you specify for
Name
:NAMESPACE_ID: Specify one namespace ID.
SERVICE_ID: Specify one service ID.
STATUS: Specify one or more statuses:
SUBMITTED
,PENDING
,SUCCEED
, orFAIL
.TYPE: Specify one or more of the following types:
CREATE_NAMESPACE
,DELETE_NAMESPACE
,UPDATE_SERVICE
,REGISTER_INSTANCE
, orDEREGISTER_INSTANCE
.UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
(string) –
Condition (string) –
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:
EQ
: When you specifyEQ
for the condition, you can specify only one value.EQ
is supported forNAMESPACE_ID
,SERVICE_ID
,STATUS
, andTYPE
.EQ
is the default condition and can be omitted.IN
: When you specifyIN
for the condition, you can specify a list of one or more values.IN
is supported forSTATUS
andTYPE
. An operation must match one of the specified values to be returned in the response.BETWEEN
: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEEN
is supported forUPDATE_DATE
.
- Return type:
dict
- Returns:
Response Syntax
{ 'Operations': [ { 'Id': 'string', 'Status': 'SUBMITTED'|'PENDING'|'SUCCESS'|'FAIL' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Operations (list) –
Summary information about the operations that match the specified criteria.
(dict) –
A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.
Id (string) –
The ID for an operation.
Status (string) –
The status of the operation. Values include the following:
SUBMITTED: This is the initial state 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
.
NextToken (string) –
If the response contains
NextToken
, submit anotherListOperations
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note
Cloud Map gets
MaxResults
operations and then filters them based on the specified criteria. It’s possible that no operations in the firstMaxResults
operations matched the specified criteria but that subsequent groups ofMaxResults
operations do contain operations that match the criteria.
Exceptions
ServiceDiscovery.Client.exceptions.InvalidInput
Examples
This example gets the operations that have a STATUS of either PENDING or SUCCESS.
response = client.list_operations( Filters=[ { 'Condition': 'IN', 'Name': 'STATUS', 'Values': [ 'PENDING', 'SUCCESS', ], }, ], ) print(response)
Expected Output:
{ 'Operations': [ { 'Id': '76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample', 'Status': 'SUCCESS', }, { 'Id': 'prysnyzpji3u2ciy45nke83x2zanl7yk-dexample', 'Status': 'SUCCESS', }, { 'Id': 'ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example', 'Status': 'PENDING', }, ], 'ResponseMetadata': { '...': '...', }, }