ListSecurityProfileApplicationsCommand

Returns a list of third-party applications in a specific security profile.

Example Syntax

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

import { ConnectClient, ListSecurityProfileApplicationsCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListSecurityProfileApplicationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListSecurityProfileApplicationsRequest
  SecurityProfileId: "STRING_VALUE", // required
  InstanceId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListSecurityProfileApplicationsCommand(input);
const response = await client.send(command);
// { // ListSecurityProfileApplicationsResponse
//   Applications: [ // Applications
//     { // Application
//       Namespace: "STRING_VALUE",
//       ApplicationPermissions: [ // ApplicationPermissions
//         "STRING_VALUE",
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
//   LastModifiedTime: new Date("TIMESTAMP"),
//   LastModifiedRegion: "STRING_VALUE",
// };

ListSecurityProfileApplicationsCommand Input

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.

MaxResults
number | undefined

The maximum number of results to return per page.

NextToken
string | undefined

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListSecurityProfileApplicationsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Applications
Application[] | undefined

A list of the third-party application's metadata.

LastModifiedRegion
string | undefined

The Amazon Web Services Region where this resource was last modified.

LastModifiedTime
Date | undefined

The timestamp when this resource was last modified.

NextToken
string | undefined

If there are additional results, this is the token for the next set of results.

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.