AWS API Changes

2021/11/04 - Amazon Connect Service - 5 new api methods

Changes This release adds CRUD operation support for Security profile resource in Amazon Connect

DescribeSecurityProfile (new)

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

Gets basic information about the security profle.

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'
        }
    }
}

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.
    - (string) --
      - (string) --

CreateSecurityProfile (new)

Link ¶

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'
    }
)

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.

(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.

(string) --
- (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.

ListSecurityProfilePermissions (new)

Link ¶

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

Lists the permissions granted to a security profile.

See also: AWS API Documentation

Request Syntax

client.list_security_profile_permissions(
    SecurityProfileId='string',
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

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 NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'Permissions': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Permissions (list) --
  
  The permissions granted to the security profile.
  - (string) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

DeleteSecurityProfile (new)

Link ¶

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

Deletes a security profile.

See also: AWS API Documentation

Request Syntax

client.delete_security_profile(
    InstanceId='string',
    SecurityProfileId='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 SecurityProfileId

string

param SecurityProfileId

[REQUIRED]

The identifier for the security profle.

returns

None

UpdateSecurityProfile (new)

Link ¶

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'
)

type Description

string

param Description

The description of the security profile.

type Permissions

list

param Permissions

The permissions granted to a security profile.

(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.

returns

None