AWS API Changes

2023/09/26 - Amazon Connect Service - 1 new 4 updated api methods

Changes This release updates a set of Amazon Connect APIs that provides the ability to integrate third party applications in the Amazon Connect agent workspace.

ListSecurityProfileApplications (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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

type SecurityProfileId

string

param SecurityProfileId

[REQUIRED]

The security profile identifier.

type InstanceId

string

param InstanceId

[REQUIRED]

The instance identifier.

type NextToken

string

param NextToken

The token for the next set of results. The next set of results can be retrieved by using the token value returned in the previous response when making the next request.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'Applications': [
        {
            'Namespace': 'string',
            'ApplicationPermissions': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Applications (list) --
  
  A list of the third party application's metadata.
  - (dict) --
    
    This API is in preview release for Amazon Connect and is subject to change.
    
    A third party application's metadata.
    - Namespace (string) --
      
      Namespace of the application that you want to give access to.
    - ApplicationPermissions (list) --
      
      The permissions that the agent is granted on the application. Only the ACCESS permission is supported.
      - (string) --
- NextToken (string) --
  
  The token for the next set of results. The next set of results can be retrieved by using the token value returned in the previous response when making the next request.

CreateIntegrationAssociation (updated)

Link ¶
Changes (request)

{'IntegrationType': {'APPLICATION'}}

Creates an Amazon Web Services resource association with an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.create_integration_association(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN'|'APPLICATION',
    IntegrationArn='string',
    SourceApplicationUrl='string',
    SourceApplicationName='string',
    SourceType='SALESFORCE'|'ZENDESK',
    Tags={
        'string': 'string'
    }
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type IntegrationType

string

param IntegrationType

[REQUIRED]

The type of information to be ingested.

type IntegrationArn

string

param IntegrationArn

[REQUIRED]

The Amazon Resource Name (ARN) of the integration.

Note

When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.

type SourceApplicationUrl

string

param SourceApplicationUrl

The URL for the external application. This field is only required for the EVENT integration type.

type SourceApplicationName

string

param SourceApplicationName

The name of the external application. This field is only required for the EVENT integration type.

type SourceType

string

param SourceType

The type of the data source. This field is only required for the EVENT integration type.

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

rtype

dict

returns

Response Syntax

{
    'IntegrationAssociationId': 'string',
    'IntegrationAssociationArn': 'string'
}

Response Structure

(dict) --
- IntegrationAssociationId (string) --
  
  The identifier for the integration association.
- IntegrationAssociationArn (string) --
  
  The Amazon Resource Name (ARN) for the association.

CreateSecurityProfile (updated)

Link ¶
Changes (request)

{'Applications': [{'ApplicationPermissions': ['string'],
                   'Namespace': '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',
    ],
    Applications=[
        {
            'Namespace': 'string',
            'ApplicationPermissions': [
                '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 instance ID in the Amazon Resource Name (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. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

(string) --

type Applications

list

param Applications

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

A list of third party applications that the security profile will give access to.

(dict) --

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

A third party application's metadata.
- Namespace (string) --
  
  Namespace of the application that you want to give access to.
- ApplicationPermissions (list) --
  
  The permissions that the agent is granted on the application. Only the ACCESS permission is supported.
  - (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.

ListIntegrationAssociations (updated)

Link ¶
Changes (request, response)
Request

{'IntegrationType': {'APPLICATION'}}

Response

{'IntegrationAssociationSummaryList': {'IntegrationType': {'APPLICATION'}}}

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_integration_associations(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN'|'APPLICATION',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type IntegrationType

string

param IntegrationType

The integration type.

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

{
    'IntegrationAssociationSummaryList': [
        {
            'IntegrationAssociationId': 'string',
            'IntegrationAssociationArn': 'string',
            'InstanceId': 'string',
            'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN'|'APPLICATION',
            'IntegrationArn': 'string',
            'SourceApplicationUrl': 'string',
            'SourceApplicationName': 'string',
            'SourceType': 'SALESFORCE'|'ZENDESK'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- IntegrationAssociationSummaryList (list) --
  
  The associations.
  - (dict) --
    
    Contains summary information about the associated AppIntegrations.
    - IntegrationAssociationId (string) --
      
      The identifier for the AppIntegration association.
    - IntegrationAssociationArn (string) --
      
      The Amazon Resource Name (ARN) for the AppIntegration association.
    - InstanceId (string) --
      
      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    - IntegrationType (string) --
      
      The integration type.
    - IntegrationArn (string) --
      
      The Amazon Resource Name (ARN) for the AppIntegration.
    - SourceApplicationUrl (string) --
      
      The URL for the external application.
    - SourceApplicationName (string) --
      
      The user-provided, friendly name for the external application.
    - SourceType (string) --
      
      The name of the source.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

UpdateSecurityProfile (updated)

Link ¶
Changes (request)

{'Applications': [{'ApplicationPermissions': ['string'],
                   'Namespace': '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',
    ],
    Applications=[
        {
            'Namespace': 'string',
            'ApplicationPermissions': [
                '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 instance ID in the Amazon Resource Name (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) --

type Applications

list

param Applications

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

A list of the third party application's metadata.

(dict) --

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

A third party application's metadata.
- Namespace (string) --
  
  Namespace of the application that you want to give access to.
- ApplicationPermissions (list) --
  
  The permissions that the agent is granted on the application. Only the ACCESS permission is supported.
  - (string) --

returns

None