Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListOperations

Lists operations that match the criteria that you specify.

Request Syntax


{
   "Filters": [ 
      { 
         "Condition": "string",
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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.

Type: Array of OperationFilter objects

Required: No

MaxResults

The maximum number of items that you want AWS Cloud Map to return in the response to a ListOperations request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 operations.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

For the first ListOperations request, omit this value.

If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Note

AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

Response Syntax


{
   "NextToken": "string",
   "Operations": [ 
      { 
         "Id": "string",
         "Status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Note

Type: String

Length Constraints: Maximum length of 4096.

Operations

Summary information about the operations that match the specified criteria.

Type: Array of OperationSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInput

One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

HTTP Status Code: 400

Examples

ListOperations Example

This example illustrates one usage of ListOperations.

Sample Request


POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20181118T211813Z
authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request,
               SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
               Signature=[calculated-signature]
x-amz-target:Route53AutoNaming_v20170314.ListOperations
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]

{
    "Filters": [
        {
            "Name": "STATUS",
            "Condition": "IN",
            "Values": [
                "PENDING",
                "SUCCESS"
            ]
        }
    ]
}

Sample Response


HTTP/1.1 200
Content-Length: [number of characters in the JSON string]
Content-Type: application/x-amz-json-1.1

{
    "Operations": [
        {
            "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample",
            "Status": "SUCCESS"
        },
        {
            "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample",
            "Status": "SUCCESS"
        },
        {
            "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example",
            "Status": "PENDING"
        }
    ]
}