2023/09/01 - Amazon Connect Service - 9 new api methods
Changes Amazon Connect adds the ability to read, create, update, delete, and list view resources, and adds the ability to read, create, delete, and list view versions.
Deletes the particular version specified in ViewVersion identifier.
See also: AWS API Documentation
Request Syntax
client.delete_view_version(
InstanceId='string',
ViewId='string',
ViewVersion=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the view. Both ViewArn and ViewId can be used.
integer
[REQUIRED]
The version number of the view.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the view metadata. Note that either Name or Description must be provided.
See also: AWS API Documentation
Request Syntax
client.update_view_metadata(
InstanceId='string',
ViewId='string',
Name='string',
Description='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the view. Both ViewArn and ViewId can be used.
string
The name of the view.
string
The description of the view.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new view with the possible status of SAVED or PUBLISHED .
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED . An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.
See also: AWS API Documentation
Request Syntax
client.create_view(
InstanceId='string',
ClientToken='string',
Status='PUBLISHED'|'SAVED',
Content={
'Template': 'string',
'Actions': [
'string',
]
},
Description='string',
Name='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.
string
[REQUIRED]
Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status will initiate validation on the content.
dict
[REQUIRED]
View content containing all content necessary to render a view except for runtime input data.
The total uncompressed content has a maximum file size of 400kB.
Template (string) --
The view template representing the structure of the view.
Actions (list) --
A list of possible actions from the view.
(string) --
string
The description of the view.
string
[REQUIRED]
The name of the view.
dict
The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Response Syntax
{
'View': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'PUBLISHED'|'SAVED',
'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'Description': 'string',
'Version': 123,
'VersionDescription': 'string',
'Content': {
'InputSchema': 'string',
'Template': 'string',
'Actions': [
'string',
]
},
'Tags': {
'string': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'ViewContentSha256': 'string'
}
}
Response Structure
(dict) --
View (dict) --
A view resource object. Contains metadata and content necessary to render the view.
Id (string) --
The identifier of the view.
Arn (string) --
The Amazon Resource Name (ARN) of the view.
Name (string) --
The name of the view.
Status (string) --
Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status will initiate validation on the content.
Type (string) --
The type of the view - CUSTOMER_MANAGED .
Description (string) --
The description of the view.
Version (integer) --
Current version of the view.
VersionDescription (string) --
The description of the version.
Content (dict) --
View content containing all content necessary to render a view except for runtime input data.
InputSchema (string) --
The data schema matching data that the view template must be provided to render.
Template (string) --
The view template representing the structure of the view.
Actions (list) --
A list of possible actions from the view.
(string) --
Tags (dict) --
The tags associated with the view resource (not specific to view version).
(string) --
(string) --
CreatedTime (datetime) --
The timestamp of when the view was created.
LastModifiedTime (datetime) --
Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
ViewContentSha256 (string) --
Indicates the checksum value of the latest published view content.
Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
See also: AWS API Documentation
Request Syntax
client.list_views(
InstanceId='string',
Type='CUSTOMER_MANAGED'|'AWS_MANAGED',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
The type of the view.
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
{
'ViewsSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'Status': 'PUBLISHED'|'SAVED',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ViewsSummaryList (list) --
A list of view summaries.
(dict) --
A summary of a view's metadata.
Id (string) --
The identifier of the view.
Arn (string) --
The Amazon Resource Name (ARN) of the view.
Name (string) --
The name of the view.
Type (string) --
The type of the view.
Status (string) --
Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status will initiate validation on the content.
Description (string) --
The description of the view.
NextToken (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.
Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.
See also: AWS API Documentation
Request Syntax
client.create_view_version(
InstanceId='string',
ViewId='string',
VersionDescription='string',
ViewContentSha256='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the view. Both ViewArn and ViewId can be used.
string
The description for the version being published.
string
Indicates the checksum value of the latest published view content.
dict
Response Syntax
{
'View': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'PUBLISHED'|'SAVED',
'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'Description': 'string',
'Version': 123,
'VersionDescription': 'string',
'Content': {
'InputSchema': 'string',
'Template': 'string',
'Actions': [
'string',
]
},
'Tags': {
'string': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'ViewContentSha256': 'string'
}
}
Response Structure
(dict) --
View (dict) --
All view data is contained within the View object.
Id (string) --
The identifier of the view.
Arn (string) --
The Amazon Resource Name (ARN) of the view.
Name (string) --
The name of the view.
Status (string) --
Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status will initiate validation on the content.
Type (string) --
The type of the view - CUSTOMER_MANAGED .
Description (string) --
The description of the view.
Version (integer) --
Current version of the view.
VersionDescription (string) --
The description of the version.
Content (dict) --
View content containing all content necessary to render a view except for runtime input data.
InputSchema (string) --
The data schema matching data that the view template must be provided to render.
Template (string) --
The view template representing the structure of the view.
Actions (list) --
A list of possible actions from the view.
(string) --
Tags (dict) --
The tags associated with the view resource (not specific to view version).
(string) --
(string) --
CreatedTime (datetime) --
The timestamp of when the view was created.
LastModifiedTime (datetime) --
Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
ViewContentSha256 (string) --
Indicates the checksum value of the latest published view content.
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
See also: AWS API Documentation
Request Syntax
client.list_view_versions(
InstanceId='string',
ViewId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the view. Both ViewArn and ViewId can be used.
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
{
'ViewVersionSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Description': 'string',
'Name': 'string',
'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'Version': 123,
'VersionDescription': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ViewVersionSummaryList (list) --
A list of view version summaries.
(dict) --
A summary of a view version's metadata.
Id (string) --
The identifier of the view version.
Arn (string) --
The Amazon Resource Name (ARN) of the view version.
Description (string) --
The description of the view version.
Name (string) --
The name of the view version.
Type (string) --
The type of the view version.
Version (integer) --
The sequentially incremented version of the view version.
VersionDescription (string) --
The description of the view version.
NextToken (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.
Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED , which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST . If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.
See also: AWS API Documentation
Request Syntax
client.describe_view(
InstanceId='string',
ViewId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The ViewId of the view. This must be an ARN for Amazon Web Services managed views.
dict
Response Syntax
{
'View': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'PUBLISHED'|'SAVED',
'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'Description': 'string',
'Version': 123,
'VersionDescription': 'string',
'Content': {
'InputSchema': 'string',
'Template': 'string',
'Actions': [
'string',
]
},
'Tags': {
'string': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'ViewContentSha256': 'string'
}
}
Response Structure
(dict) --
View (dict) --
All view data is contained within the View object.
Id (string) --
The identifier of the view.
Arn (string) --
The Amazon Resource Name (ARN) of the view.
Name (string) --
The name of the view.
Status (string) --
Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status will initiate validation on the content.
Type (string) --
The type of the view - CUSTOMER_MANAGED .
Description (string) --
The description of the view.
Version (integer) --
Current version of the view.
VersionDescription (string) --
The description of the version.
Content (dict) --
View content containing all content necessary to render a view except for runtime input data.
InputSchema (string) --
The data schema matching data that the view template must be provided to render.
Template (string) --
The view template representing the structure of the view.
Actions (list) --
A list of possible actions from the view.
(string) --
Tags (dict) --
The tags associated with the view resource (not specific to view version).
(string) --
(string) --
CreatedTime (datetime) --
The timestamp of when the view was created.
LastModifiedTime (datetime) --
Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
ViewContentSha256 (string) --
Indicates the checksum value of the latest published view content.
Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED . Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED .
See also: AWS API Documentation
Request Syntax
client.update_view_content(
InstanceId='string',
ViewId='string',
Status='PUBLISHED'|'SAVED',
Content={
'Template': 'string',
'Actions': [
'string',
]
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the view. Both ViewArn and ViewId can be used.
string
[REQUIRED]
Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status will initiate validation on the content.
dict
[REQUIRED]
View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
The total uncompressed content has a maximum file size of 400kB.
Template (string) --
The view template representing the structure of the view.
Actions (list) --
A list of possible actions from the view.
(string) --
dict
Response Syntax
{
'View': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'PUBLISHED'|'SAVED',
'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'Description': 'string',
'Version': 123,
'VersionDescription': 'string',
'Content': {
'InputSchema': 'string',
'Template': 'string',
'Actions': [
'string',
]
},
'Tags': {
'string': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'ViewContentSha256': 'string'
}
}
Response Structure
(dict) --
View (dict) --
A view resource object. Contains metadata and content necessary to render the view.
Id (string) --
The identifier of the view.
Arn (string) --
The Amazon Resource Name (ARN) of the view.
Name (string) --
The name of the view.
Status (string) --
Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status will initiate validation on the content.
Type (string) --
The type of the view - CUSTOMER_MANAGED .
Description (string) --
The description of the view.
Version (integer) --
Current version of the view.
VersionDescription (string) --
The description of the version.
Content (dict) --
View content containing all content necessary to render a view except for runtime input data.
InputSchema (string) --
The data schema matching data that the view template must be provided to render.
Template (string) --
The view template representing the structure of the view.
Actions (list) --
A list of possible actions from the view.
(string) --
Tags (dict) --
The tags associated with the view resource (not specific to view version).
(string) --
(string) --
CreatedTime (datetime) --
The timestamp of when the view was created.
LastModifiedTime (datetime) --
Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
ViewContentSha256 (string) --
Indicates the checksum value of the latest published view content.
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
See also: AWS API Documentation
Request Syntax
client.delete_view(
InstanceId='string',
ViewId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the view. Both ViewArn and ViewId can be used.
dict
Response Syntax
{}
Response Structure
(dict) --