subscription_requests

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

Overview

Name	subscription_requests
Type	Resource
Id	aws.datazone.subscription_requests

Fields

The following fields are returned by SELECT queries:

list_subscription_requests

Name	Datatype	Description
id	string	The identifier of the subscription request. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
created_at	string (date-time)	The timestamp of when a subscription request was created.
created_by	string	The Amazon DataZone user who created the subscription request.
decision_comment	string	The decision comment of the subscription request.
domain_id	string	The identifier of the Amazon DataZone domain in which a subscription request exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
existing_subscription_id	string	The ID of the existing subscription. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
metadata_forms_summary	array	The summary of the metadata forms.
request_reason	string	The reason for the subscription request.
reviewer_id	string	The identifier of the subscription request reviewer.
status	string	The status of the subscription request. (PENDING, ACCEPTED, REJECTED)
subscribed_listings	array	The listings included in the subscription request.
subscribed_principals	array	The principals included in the subscription request.
updated_at	string (date-time)	The timestamp of when the subscription request was updated.
updated_by	string	The identifier of the Amazon DataZone user who updated the subscription request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_subscription_requests	select	domain_identifier, region	status, subscribedListingId, owningProjectId, owningIamPrincipalArn, approverProjectId, owningUserId, owningGroupId, sortBy, sortOrder, maxResults, nextToken	Lists Amazon DataZone subscription requests.
create_subscription_request	insert	domain_identifier, region, subscribedPrincipals, subscribedListings, requestReason		Creates a subscription request in Amazon DataZone.
update_subscription_request	update	domain_identifier, identifier, region, requestReason		Updates a specified subscription request in Amazon DataZone.
delete_subscription_request	delete	domain_identifier, identifier, region		Deletes a subscription request in Amazon DataZone.

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
domain_identifier	string	The ID of the Amazon DataZone domain in which the subscription request is deleted.
identifier	string	The ID of the subscription request that is deleted.
region	string	AWS region (default: us-east-1)
approverProjectId	string	The identifier of the subscription request approver's project.
maxResults	integer	The maximum number of subscription requests to return in a single call to ListSubscriptionRequests. When the number of subscription requests to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.
nextToken	string	When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.
owningGroupId	string	The ID of the owning group.
owningIamPrincipalArn	string	The ARN of the owning IAM principal.
owningProjectId	string	The identifier of the project for the subscription requests.
owningUserId	string	The ID of the owning user.
sortBy	string	Specifies the way to sort the results of this action.
sortOrder	string	Specifies the sort order for the results of this action.
status	string	Specifies the status of the subscription requests. This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.
subscribedListingId	string	The identifier of the subscribed listing.

SELECT examples

list_subscription_requests

Lists Amazon DataZone subscription requests.

SELECT
id,
created_at,
created_by,
decision_comment,
domain_id,
existing_subscription_id,
metadata_forms_summary,
request_reason,
reviewer_id,
status,
subscribed_listings,
subscribed_principals,
updated_at,
updated_by
FROM aws.datazone.subscription_requests
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND subscribedListingId = '{{ subscribedListingId }}'
AND owningProjectId = '{{ owningProjectId }}'
AND owningIamPrincipalArn = '{{ owningIamPrincipalArn }}'
AND approverProjectId = '{{ approverProjectId }}'
AND owningUserId = '{{ owningUserId }}'
AND owningGroupId = '{{ owningGroupId }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_subscription_request

Creates a subscription request in Amazon DataZone.

INSERT INTO aws.datazone.subscription_requests (
subscribedPrincipals,
subscribedListings,
requestReason,
clientToken,
metadataForms,
assetPermissions,
assetScopes,
domain_identifier,
region
)
SELECT 
'{{ subscribedPrincipals }}' /* required */,
'{{ subscribedListings }}' /* required */,
'{{ requestReason }}' /* required */,
'{{ clientToken }}',
'{{ metadataForms }}',
'{{ assetPermissions }}',
'{{ assetScopes }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
created_at,
created_by,
decision_comment,
domain_id,
existing_subscription_id,
metadata_forms,
request_reason,
reviewer_id,
status,
subscribed_listings,
subscribed_principals,
updated_at,
updated_by
;

Manifest

# Description fields are for documentation purposes
- name: subscription_requests
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the subscription_requests resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the subscription_requests resource.
  - name: subscribedPrincipals
    value:
      - project:
          identifier: "{{ identifier }}"
        user:
          identifier: "{{ identifier }}"
        group:
          identifier: "{{ identifier }}"
        iam:
          identifier: "{{ identifier }}"
  - name: subscribedListings
    value:
      - identifier: "{{ identifier }}"
  - name: requestReason
    value: "{{ requestReason }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: metadataForms
    value:
      - formName: "{{ formName }}"
        typeIdentifier: "{{ typeIdentifier }}"
        typeRevision: "{{ typeRevision }}"
        content: "{{ content }}"
  - name: assetPermissions
    value:
      - assetId: "{{ assetId }}"
        permissions:
          s3:
            - "{{ s3 }}"
  - name: assetScopes
    value:
      - assetId: "{{ assetId }}"
        filterIds: "{{ filterIds }}"

UPDATE examples

update_subscription_request

Updates a specified subscription request in Amazon DataZone.

UPDATE aws.datazone.subscription_requests
SET 
requestReason = '{{ requestReason }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
AND requestReason = '{{ requestReason }}' --required
RETURNING
id,
created_at,
created_by,
decision_comment,
domain_id,
existing_subscription_id,
metadata_forms,
request_reason,
reviewer_id,
status,
subscribed_listings,
subscribed_principals,
updated_at,
updated_by;

DELETE examples

delete_subscription_request

Deletes a subscription request in Amazon DataZone.

DELETE FROM aws.datazone.subscription_requests
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;