view_versions

Creates, updates, deletes, gets or lists a view_versions resource.

Overview

Name	view_versions
Type	Resource
Id	aws.connect.view_versions

Fields

The following fields are returned by SELECT queries:

list_view_versions

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the view version.
description	string	The description of the view version. (pattern: <code>^([\p{L}\p{N}.:/=+-@,()']+[\p{L}\p{Z}\p{N}.:/=+-@,()']*)$</code>)
id	string	The identifier of the view version. (pattern: <code>^[a-zA-Z0-9_-:/$]+$</code>)
name	string	The name of the view version. (pattern: <code>^([\p{L}\p{N}.:/=+-@()']+[\p{L}\p{Z}\p{N}.:/=+-@()']*)$</code>)
type	string	The type of the view version. (CUSTOMER_MANAGED, AWS_MANAGED)
version	integer	The sequentially incremented version of the view version.
version_description	string	The description of the view version. (pattern: <code>^([\p{L}\p{N}.:/=+-@,()']+[\p{L}\p{Z}\p{N}.:/=+-@,()']*)$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_view_versions	select	instance_id, view_id, region	nextToken, maxResults	Returns all the available versions for the specified Connect Customer instance and view identifier. Results will be sorted from highest to lowest.
create_view_version	insert	instance_id, view_id, region		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.
delete_view_version	delete	instance_id, view_id, view_version, region		Deletes the particular version specified in ViewVersion identifier.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instance_id	string	The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.
region	string	AWS region (default: us-east-1)
view_id	string	The identifier of the view. Both ViewArn and ViewId can be used.
view_version	integer	The version number of the view.
maxResults	integer	The maximum number of results to return per page. The default MaxResult size is 100.
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.

SELECT examples

list_view_versions

Returns all the available versions for the specified Connect Customer instance and view identifier. Results will be sorted from highest to lowest.

SELECT
arn,
description,
id,
name,
type,
version,
version_description
FROM aws.connect.view_versions
WHERE instance_id = '{{ instance_id }}' -- required
AND view_id = '{{ view_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_view_version

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.

INSERT INTO aws.connect.view_versions (
VersionDescription,
ViewContentSha256,
instance_id,
view_id,
region
)
SELECT 
'{{ VersionDescription }}',
'{{ ViewContentSha256 }}',
'{{ instance_id }}',
'{{ view_id }}',
'{{ region }}'
RETURNING
view
;

Manifest

# Description fields are for documentation purposes
- name: view_versions
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the view_versions resource.
  - name: view_id
    value: "{{ view_id }}"
    description: Required parameter for the view_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the view_versions resource.
  - name: VersionDescription
    value: "{{ VersionDescription }}"
  - name: ViewContentSha256
    value: "{{ ViewContentSha256 }}"

DELETE examples

delete_view_version

Deletes the particular version specified in ViewVersion identifier.

DELETE FROM aws.connect.view_versions
WHERE instance_id = '{{ instance_id }}' --required
AND view_id = '{{ view_id }}' --required
AND view_version = '{{ view_version }}' --required
AND region = '{{ region }}' --required
;