View a markdown version of this page

GetConnector - AWS Security Hub CSPM
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetConnector

Retrieves details for a CSPM connector based on the connector ID.

Request Syntax

GET /connectors/ConnectorId+ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConnectorId

The unique identifier of the connector to retrieve.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "ConnectorArn": "string",
   "ConnectorId": "string",
   "CreatedAt": "string",
   "CreatedBy": "string",
   "Description": "string",
   "EnablementStatus": "string",
   "Health": { 
      "ConnectorStatus": "string",
      "Issues": [ 
         { 
            "Code": "string",
            "Message": "string"
         }
      ],
      "LastCheckedAt": "string",
      "Message": "string"
   },
   "LastUpdatedAt": "string",
   "Name": "string",
   "ProviderDetail": { ... }
}

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.

ConnectorArn

The Amazon Resource Name (ARN) of the connector.

Type: String

Pattern: .*\S.*

ConnectorId

The unique identifier of the connector.

Type: String

Pattern: .*\S.*

CreatedAt

The ISO 8601 UTC timestamp indicating when the connector was created.

Type: Timestamp

CreatedBy

The service principal that created the connector.

Type: String

Pattern: .*\S.*

Description

The description of the connector.

Type: String

Pattern: .*\S.*

EnablementStatus

The enablement status of the connector.

Type: String

Valid Values: ENABLED | PENDING_ENABLEMENT | PENDING_UPDATE | PENDING_DELETION

Health

The health status of the connector, including connectivity status and last check time.

Type: CspmHealthCheck object

LastUpdatedAt

The ISO 8601 UTC timestamp indicating when the connector was last updated.

Type: Timestamp

Name

The name of the connector.

Type: String

Pattern: .*\S.*

ProviderDetail

The cloud provider configuration details for the connector.

Type: CspmProviderDetail object

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

Errors

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

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: