GetConnectorV2Command

Grants permission to retrieve details for a connectorV2 based on connector id. This API is in preview release and subject to change.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SecurityHubClient, GetConnectorV2Command } from "@aws-sdk/client-securityhub"; // ES Modules import
// const { SecurityHubClient, GetConnectorV2Command } = require("@aws-sdk/client-securityhub"); // CommonJS import
const client = new SecurityHubClient(config);
const input = { // GetConnectorV2Request
  ConnectorId: "STRING_VALUE", // required
};
const command = new GetConnectorV2Command(input);
const response = await client.send(command);
// { // GetConnectorV2Response
//   ConnectorArn: "STRING_VALUE",
//   ConnectorId: "STRING_VALUE", // required
//   Name: "STRING_VALUE", // required
//   Description: "STRING_VALUE",
//   KmsKeyArn: "STRING_VALUE",
//   CreatedAt: new Date("TIMESTAMP"), // required
//   LastUpdatedAt: new Date("TIMESTAMP"), // required
//   Health: { // HealthCheck
//     ConnectorStatus: "CONNECTED" || "FAILED_TO_CONNECT" || "PENDING_CONFIGURATION" || "PENDING_AUTHORIZATION", // required
//     Message: "STRING_VALUE",
//     LastCheckedAt: new Date("TIMESTAMP"), // required
//   },
//   ProviderDetail: { // ProviderDetail Union: only one key present
//     JiraCloud: { // JiraCloudDetail
//       CloudId: "STRING_VALUE",
//       ProjectKey: "STRING_VALUE",
//       Domain: "STRING_VALUE",
//       AuthUrl: "STRING_VALUE",
//       AuthStatus: "ACTIVE" || "FAILED",
//     },
//     ServiceNow: { // ServiceNowDetail
//       InstanceName: "STRING_VALUE",
//       ClientId: "STRING_VALUE",
//       AuthStatus: "ACTIVE" || "FAILED", // required
//     },
//   },
// };

GetConnectorV2Command Input

See GetConnectorV2CommandInput for more details

Parameter
Type
Description
ConnectorId
Required
string | undefined

The UUID of the connectorV2 to identify connectorV2 resource.

GetConnectorV2Command Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ConnectorId
Required
string | undefined

The UUID of the connectorV2 to identify connectorV2 resource.

CreatedAt
Required
Date | undefined

ISO 8601 UTC timestamp for the time create the connectorV2.

Health
Required
HealthCheck | undefined

The current health status for connectorV2

LastUpdatedAt
Required
Date | undefined

ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.

Name
Required
string | undefined

The name of the connectorV2.

ProviderDetail
Required
ProviderDetail | undefined

The third-party provider detail for a service configuration.

ConnectorArn
string | undefined

The Amazon Resource Name (ARN) of the connectorV2.

Description
string | undefined

The description of the connectorV2.

KmsKeyArn
string | undefined

The Amazon Resource Name (ARN) of KMS key used for the connectorV2.

Throws

Name
Fault
Details
AccessDeniedException
client

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

ConflictException
client

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

InternalServerException
server

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

ResourceNotFoundException
client

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

ThrottlingException
client

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

ValidationException
client

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

SecurityHubServiceException
Base exception class for all service exceptions from SecurityHub service.