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

UpdateCloudConnector

Updates an existing cloud connector with new configuration details.

Request Syntax


{
   "CloudConnectorId": "string",
   "Configuration": { ... },
   "Description": "string",
   "DisplayName": "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 update.

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

Configuration

The updated configuration details for connecting to the third-party cloud environment.

Type: CloudConnectorConfiguration object

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

Required: No

Description

A new description for 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}]*)$

Required: No

DisplayName

A new friendly name for 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}]*)$

Required: No

Response Syntax


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

CloudConnectorId

The ID of the cloud connector that was updated.

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}$

Errors

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

ConflictException

An error occurred because of a conflict with a concurrent request or the current state of the resource. Retry your request.

HTTP Status Code: 400

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 UpdateCloudConnector.

Sample Request


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

{
    "CloudConnectorId": "8077bdca-72e6-4cda-8fd9-09bae51454f6",
    "DisplayName": "MyAzureConnector-Updated",
    "Description": "Updated Azure connector",
    "Configuration": {
        "AzureConfiguration": {
            "TenantId": "263dd747-5cc8-4e18-abf2-a25d8e374f66",
            "ApplicationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Targets": {
                "Subscriptions": [
                    {
                        "Id": "14724fea-7bad-4c32-8af0-ebde38f42a46",
                        "DisplayName": "ProductionSubscription"
                    },
                    {
                        "Id": "25835gfb-8cae-5d43-9bg1-fcef49g53b57",
                        "DisplayName": "StagingSubscription"
                    }
                ]
            }
        }
    }
}

Sample Response


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