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

ValidateCloudConnector

Validates the configuration and connectivity of a cloud connector.

Request Syntax


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

CloudConnectorId

The ID of the cloud connector to validate.

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

MaxResults

The maximum number of validation findings to return.

Type: Integer

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

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


{
   "NextToken": "string",
   "ValidationFindings": [ 
      { 
         "Code": "string",
         "Message": "string",
         "ProviderMessage": "string",
         "Scope": { 
            "Id": "string",
            "Type": "string"
         },
         "Type": "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

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

Type: String

ValidationFindings

A list of validation findings for the cloud connector.

Type: Array of ValidationFinding objects

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

Sample Request


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


{
    "ValidationFindings": [
        {
            "Type": "ERROR",
            "Code": "TargetInaccessible",
            "Message": "Target not found or not accessible with the provided credentials",
            "Scope": {
                "Type": "azure:subscription",
                "Id": "14724fea-7bad-4c32-8af0-ebde38f42a46"
            }
        }
    ]
}