DescribeSecurityProfileCommand

Suggest an Edit

Gets basic information about the security profile.

For information about security profiles, see Security Profiles  in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions .

Example Syntax

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

import { ConnectClient, DescribeSecurityProfileCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribeSecurityProfileCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribeSecurityProfileRequest
  SecurityProfileId: "STRING_VALUE", // required
  InstanceId: "STRING_VALUE", // required
};
const command = new DescribeSecurityProfileCommand(input);
const response = await client.send(command);
// { // DescribeSecurityProfileResponse
//   SecurityProfile: { // SecurityProfile
//     Id: "STRING_VALUE",
//     OrganizationResourceId: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     SecurityProfileName: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     AllowedAccessControlTags: { // AllowedAccessControlTags
//       "<keys>": "STRING_VALUE",
//     },
//     TagRestrictedResources: [ // TagRestrictedResourceList
//       "STRING_VALUE",
//     ],
//     LastModifiedTime: new Date("TIMESTAMP"),
//     LastModifiedRegion: "STRING_VALUE",
//     HierarchyRestrictedResources: [ // HierarchyRestrictedResourceList
//       "STRING_VALUE",
//     ],
//     AllowedAccessControlHierarchyGroupId: "STRING_VALUE",
//   },
// };

DescribeSecurityProfileCommand Input

See DescribeSecurityProfileCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

The identifier of the Amazon Connect instance. You can find the instance ID  in the Amazon Resource Name (ARN) of the instance.

SecurityProfileId
Required
string | undefined

The identifier for the security profle.

DescribeSecurityProfileCommand Output

See DescribeSecurityProfileCommandOutput for details

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

The security profile.

Throws

Name
Fault
Details
InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.