customer_agreements

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

Overview

Name	customer_agreements
Type	Resource
Id	aws.artifact.customer_agreements

Fields

The following fields are returned by SELECT queries:

list_customer_agreements

Name	Datatype	Description
id	string	Identifier of the customer-agreement resource. (pattern: <code>customer-agreement-[a-zA-Z0-9]{16}</code>)
name	string	Name of the customer-agreement resource. (pattern: <code>[^<>]*</code>)
acceptance_terms	array	Terms required to accept the agreement resource.
agreement_arn	string	ARN of the agreement resource the customer-agreement resource represents. (pattern: <code>[^<>]*</code>)
arn	string	ARN of the customer-agreement resource. (pattern: <code>[^<>]*</code>)
aws_account_id	string	AWS account Id that owns the resource. (pattern: <code>[a-zA-Z0-9_-\s]*</code>)
description	string	Description of the resource. (pattern: <code>[^<>]*</code>)
effective_end	string (date-time)	Timestamp indicating when the agreement was terminated.
effective_start	string (date-time)	Timestamp indicating when the agreement became effective.
organization_arn	string	ARN of the organization that owns the resource. (pattern: <code>[^<>]*</code>)
state	string	State of the resource. (ACTIVE, CUSTOMER_TERMINATED, AWS_TERMINATED)
terminate_terms	array	Terms required to terminate the customer-agreement resource.
type_	string	Type of the customer-agreement resource. (CUSTOM, DEFAULT, MODIFIED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_customer_agreements	select	region	maxResults, nextToken	List active customer-agreements applicable to calling identity.

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
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of resources to return in the paginated response.
nextToken	string	Pagination token to request the next page of resources.

SELECT examples

list_customer_agreements

List active customer-agreements applicable to calling identity.

SELECT
id,
name,
acceptance_terms,
agreement_arn,
arn,
aws_account_id,
description,
effective_end,
effective_start,
organization_arn,
state,
terminate_terms,
type_
FROM aws.artifact.customer_agreements
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;