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

GetCloudConnector

Returns detailed information about a cloud connector.

Request Syntax


{
   "CloudConnectorId": "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.

CloudConnectorId

The ID of the cloud connector to retrieve information about.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Response Syntax


{
   "CloudConnectorArn": "string",
   "ConfigConnectorArn": "string",
   "Configuration": { ... },
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "RoleArn": "string",
   "UpdatedAt": number
}

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.

CloudConnectorArn

The ARN of the cloud connector.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws(-cn|-us-gov)?:ssm:([^:]+):\d{12}:cloud-connector/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

ConfigConnectorArn

The ARN of the AWS Config connector associated with this cloud connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^arn:aws(-cn|-us-gov)?:config:([^:]+):\d{12}:connector/.+$

Configuration

The configuration details for the third-party cloud environment connection.

Type: CloudConnectorConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

CreatedAt

The date and time the cloud connector was created.

Type: Timestamp

Description

The description of the cloud connector.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: ^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$

DisplayName

The friendly name of the cloud connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$

RoleArn

The ARN of the IAM role used by the cloud connector.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z0-9-]*:iam::\d{12}:role\/[\w-\/.@+=,]{1,1017}$

UpdatedAt

The date and time the cloud connector was last updated.

Type: Timestamp

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

ResourceNotFoundException

The specified parameter to be shared could not be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetCloudConnector.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetCloudConnector
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: 62

{
    "CloudConnectorId": "8077bdca-72e6-4cda-8fd9-09bae51454f6"
}

Sample Response


{
    "CloudConnectorArn": "arn:aws:ssm:us-east-2:123456789012:cloud-connector/8077bdca-72e6-4cda-8fd9-09bae51454f6",
    "DisplayName": "MyAzureConnector",
    "Description": "Azure connector for production workloads",
    "RoleArn": "arn:aws:iam::123456789012:role/SSMAzureConnectorRole",
    "ConfigConnectorArn": "arn:aws:config:us-east-2:123456789012:connector/azure/263dd747-5cc8-4e18-abf2-a25d8e374f66/061a61b6-5954-4b72-b6a2-458c62d046d9",
    "Configuration": {
        "AzureConfiguration": {
            "TenantId": "263dd747-5cc8-4e18-abf2-a25d8e374f66",
            "TenantDisplayName": "MyAzureTenant",
            "ApplicationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ApplicationDisplayName": "SSMAdminApp",
            "Targets": {
                "Subscriptions": [
                    {
                        "Id": "14724fea-7bad-4c32-8af0-ebde38f42a46",
                        "DisplayName": "ProductionSubscription"
                    }
                ]
            }
        }
    },
    "CreatedAt": "2024-02-20T23:25:03.000Z",
    "UpdatedAt": "2024-02-20T23:25:03.000Z"
}