views

Creates, updates, deletes or gets a view resource or lists views in a region

Overview

Name	views
Type	Resource
Description	Resource Type definition for AWS::Connect::View
Id	awscc.connect.views

Fields

get (all properties)

Name	Datatype	Description
instance_arn	string	The Amazon Resource Name (ARN) of the instance.
view_arn	string	The Amazon Resource Name (ARN) of the view.
view_id	string	The view id of the view.
name	string	The name of the view.
description	string	The description of the view.
template	object	The template of the view as JSON.
actions	array	The actions of the view in an array.
view_content_sha256	string	The view content hash.
▶tags	array	One or more tags.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
view_arn	string	The Amazon Resource Name (ARN) of the view.
region	string	AWS region.

For more information, see AWS::Connect::View.

Methods

Name	Resource	Accessible by	Required Params
create_resource	views	INSERT	InstanceArn, Template, Actions, Name, region
delete_resource	views	DELETE	Identifier, region
update_resource	views	UPDATE	Identifier, PatchDocument, region
list_resources	views_list_only	SELECT	region
get_resource	views	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual view.

SELECT
  region,
  instance_arn,
  view_arn,
  view_id,
  name,
  description,
  template,
  actions,
  view_content_sha256,
  tags
FROM awscc.connect.views
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ view_arn }}';

list (identifiers only)

Lists all views in a region.

SELECT
  region,
  view_arn
FROM awscc.connect.views_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new view resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.connect.views (
  InstanceArn,
  Name,
  Template,
  Actions,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ template }}',
  '{{ actions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.views (
  InstanceArn,
  Name,
  Description,
  Template,
  Actions,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ description }}',
  '{{ template }}',
  '{{ actions }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: view
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: template
      value: {}
    - name: actions
      value:
        - '{{ actions[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a view resource, using stack-deploy.

/*+ update */
UPDATE awscc.connect.views
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Name": name,
    "Description": description,
    "Template": template,
    "Actions": actions,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ view_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.connect.views
WHERE
  Identifier = '{{ view_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the views resource, the following permissions are required:

Create

connect:CreateView,
connect:TagResource

Read

connect:DescribeView

Delete

connect:DeleteView,
connect:UntagResource

List

connect:ListViews

Update

connect:UpdateViewMetadata,
connect:UpdateViewContent,
connect:TagResource,
connect:UntagResource