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

ListCloudConnectors

Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.

Request Syntax


{
   "Filters": [ 
      { 
         "FilterKey": "string",
         "FilterValues": [ "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

One or more filters to limit the cloud connectors returned in the response.

Type: Array of CloudConnectorFilter objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: No

MaxResults

The maximum number of items to return for this call.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10.

Required: No

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Required: No

Response Syntax


{
   "CloudConnectors": [ 
      { 
         "CloudConnectorId": "string",
         "CreatedAt": number,
         "Description": "string",
         "DisplayName": "string",
         "RoleArn": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "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.

CloudConnectors

A list of cloud connector summary objects.

Type: Array of CloudConnectorSummary objects

NextToken

The token to use when requesting the next set of items.

Type: String

Errors

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

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of ListCloudConnectors.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListCloudConnectors
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240220T232503Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2

{}

Sample Response


{
    "CloudConnectors": [
        {
            "CloudConnectorId": "8077bdca-72e6-4cda-8fd9-09bae51454f6",
            "DisplayName": "MyAzureConnector",
            "Description": "Azure connector for production workloads",
            "RoleArn": "arn:aws:iam::123456789012:role/SSMAzureConnectorRole",
            "CreatedAt": "2024-02-20T23:25:03.000Z",
            "UpdatedAt": "2024-02-20T23:25:03.000Z"
        }
    ]
}