2026/10/21 - Amazon Connect Service - 3 updated api methods
Changes Added support for AWS-managed security profiles.
{'SecurityProfile': {'Type': 'AWS_MANAGED | CUSTOMER_MANAGED'}}
Gets basic information about the security profile.
For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
See also: AWS API Documentation
Request Syntax
client.describe_security_profile(
SecurityProfileId='string',
InstanceId='string'
)
string
[REQUIRED]
The identifier for the security profle.
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{
'SecurityProfile': {
'Id': 'string',
'OrganizationResourceId': 'string',
'Arn': 'string',
'SecurityProfileName': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
},
'AllowedAccessControlTags': {
'string': 'string'
},
'TagRestrictedResources': [
'string',
],
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'HierarchyRestrictedResources': [
'string',
],
'AllowedAccessControlHierarchyGroupId': 'string',
'GranularAccessControlConfiguration': {
'DataTableAccessControlConfiguration': {
'PrimaryAttributeAccessControlConfiguration': {
'PrimaryAttributeValues': [
{
'AccessType': 'ALLOW',
'AttributeName': 'string',
'Values': [
'string',
]
},
]
}
}
},
'Type': 'AWS_MANAGED'|'CUSTOMER_MANAGED'
}
}
Response Structure
(dict) --
SecurityProfile (dict) --
The security profile.
Id (string) --
The identifier for the security profile.
OrganizationResourceId (string) --
The organization resource identifier for the security profile.
Arn (string) --
The Amazon Resource Name (ARN) for the security profile.
SecurityProfileName (string) --
The name for the security profile.
Description (string) --
The description of the security profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
AllowedAccessControlTags (dict) --
The list of tags that a security profile uses to restrict access to resources in Connect Customer.
(string) --
(string) --
TagRestrictedResources (list) --
The list of resources that a security profile applies tag restrictions to in Connect Customer.
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
HierarchyRestrictedResources (list) --
The list of resources that a security profile applies hierarchy restrictions to in Connect Customer. Following are acceptable ResourceNames: User.
(string) --
AllowedAccessControlHierarchyGroupId (string) --
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Connect Customer.
GranularAccessControlConfiguration (dict) --
The granular access control configuration for the security profile, including data table permissions.
DataTableAccessControlConfiguration (dict) --
The access control configuration for data tables.
PrimaryAttributeAccessControlConfiguration (dict) --
The configuration's primary attribute access control configuration.
PrimaryAttributeValues (list) --
The item's primary attribute values.
(dict) --
A primary attribute value.
AccessType (string) --
The value's access type.
AttributeName (string) --
The value's attribute name.
Values (list) --
The value's values.
(string) --
Type (string) --
The type of the security profile: AWS_MANAGED or CUSTOMER_MANAGED.
{'SecurityProfileSummaryList': {'Type': 'AWS_MANAGED | CUSTOMER_MANAGED'}}
Provides summary information about the security profiles for the specified Connect Customer instance.
For more information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
See also: AWS API Documentation
Request Syntax
client.list_security_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'SecurityProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Type': 'AWS_MANAGED'|'CUSTOMER_MANAGED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityProfileSummaryList (list) --
Information about the security profiles.
(dict) --
Contains information about a security profile.
Id (string) --
The identifier of the security profile.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
Name (string) --
The name of the security profile.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
Type (string) --
The type of the security profile: AWS_MANAGED or CUSTOMER_MANAGED.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'SecurityProfiles': {'Type': 'AWS_MANAGED | CUSTOMER_MANAGED'}}
Searches security profiles in an Connect Customer instance, with optional filtering.
For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
See also: AWS API Documentation
Request Syntax
client.search_security_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
},
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
}
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
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.
integer
The maximum number of results to return per page.
dict
The search criteria to be used to return security profiles.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return security profiles.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return security profiles.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
Response Syntax
{
'SecurityProfiles': [
{
'Id': 'string',
'OrganizationResourceId': 'string',
'Arn': 'string',
'SecurityProfileName': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
},
'Type': 'AWS_MANAGED'|'CUSTOMER_MANAGED'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
SecurityProfiles (list) --
Information about the security profiles.
(dict) --
Information about the returned security profiles.
Id (string) --
The identifier of the security profile.
OrganizationResourceId (string) --
The organization resource identifier.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
SecurityProfileName (string) --
The name of the security profile.
Description (string) --
The description of the security profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
Type (string) --
The type of the security profile: AWS_MANAGED or CUSTOMER_MANAGED.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of security profiles which matched your search query.