AWS API Changes

2022/11/18 - Amazon Connect Service - 3 updated api methods

Changes Added AllowedAccessControlTags and TagRestrictedResource for Tag Based Access Control on Amazon Connect Webpage

CreateSecurityProfile (updated)

Link ¶
Changes (request)

{'AllowedAccessControlTags': {'string': 'string'},
 'TagRestrictedResources': ['string']}

This API is in preview release for Amazon Connect and is subject to change.

Creates a security profile.

See also: AWS API Documentation

Request Syntax

client.create_security_profile(
    SecurityProfileName='string',
    Description='string',
    Permissions=[
        'string',
    ],
    InstanceId='string',
    Tags={
        'string': 'string'
    },
    AllowedAccessControlTags={
        'string': 'string'
    },
    TagRestrictedResources=[
        'string',
    ]
)

type SecurityProfileName:

string

param SecurityProfileName:

[REQUIRED]

The name of the security profile.

type Description:

string

param Description:

The description of the security profile.

type Permissions:

list

param Permissions:

Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

(string) --

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

(string) --
- (string) --

type AllowedAccessControlTags:

dict

param AllowedAccessControlTags:

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

(string) --
- (string) --

type TagRestrictedResources:

list

param TagRestrictedResources:

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'SecurityProfileId': 'string',
    'SecurityProfileArn': 'string'
}

Response Structure

(dict) --
- SecurityProfileId (string) --
  
  The identifier for the security profle.
- SecurityProfileArn (string) --
  
  The Amazon Resource Name (ARN) for the security profile.

DescribeSecurityProfile (updated)

Link ¶
Changes (response)

{'SecurityProfile': {'AllowedAccessControlTags': {'string': 'string'},
                     'TagRestrictedResources': ['string']}}

This API is in preview release for Amazon Connect and is subject to change.

Gets basic information about the security profle.

See also: AWS API Documentation

Request Syntax

client.describe_security_profile(
    SecurityProfileId='string',
    InstanceId='string'
)

type SecurityProfileId:

string

param SecurityProfileId:

[REQUIRED]

The identifier for the security profle.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

rtype:

dict

returns:

Response Syntax

{
    'SecurityProfile': {
        'Id': 'string',
        'OrganizationResourceId': 'string',
        'Arn': 'string',
        'SecurityProfileName': 'string',
        'Description': 'string',
        'Tags': {
            'string': 'string'
        },
        'AllowedAccessControlTags': {
            'string': 'string'
        },
        'TagRestrictedResources': [
            'string',
        ]
    }
}

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 secruity 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 Amazon Connect.
    - (string) --
      - (string) --
  - TagRestrictedResources (list) --
    
    The list of resources that a security profile applies tag restrictions to in Amazon Connect.
    - (string) --

UpdateSecurityProfile (updated)

Link ¶
Changes (request)

{'AllowedAccessControlTags': {'string': 'string'},
 'TagRestrictedResources': ['string']}

This API is in preview release for Amazon Connect and is subject to change.

Updates a security profile.

See also: AWS API Documentation

Request Syntax

client.update_security_profile(
    Description='string',
    Permissions=[
        'string',
    ],
    SecurityProfileId='string',
    InstanceId='string',
    AllowedAccessControlTags={
        'string': 'string'
    },
    TagRestrictedResources=[
        'string',
    ]
)

type Description:

string

param Description:

The description of the security profile.

type Permissions:

list

param Permissions:

The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.

(string) --

type SecurityProfileId:

string

param SecurityProfileId:

[REQUIRED]

The identifier for the security profle.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type AllowedAccessControlTags:

dict

param AllowedAccessControlTags:

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

(string) --
- (string) --

type TagRestrictedResources:

list

param TagRestrictedResources:

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

(string) --

returns:

None