Create Subscription Request

datazone_create_subscription_request

R Documentation

Creates a subscription request in Amazon DataZone

Description

Creates a subscription request in Amazon DataZone.

Usage

datazone_create_subscription_request(domainIdentifier,
  subscribedPrincipals, subscribedListings, requestReason, clientToken,
  metadataForms, assetPermissions, assetScopes)

Arguments

domainIdentifier	[required] The ID of the Amazon DataZone domain in which the subscription request is created.
subscribedPrincipals	[required] The Amazon DataZone principals for whom the subscription request is created.
subscribedListings	[required] The published asset for which the subscription grant is to be created.
requestReason	[required] The reason for the subscription request.
clientToken	A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
metadataForms	The metadata form included in the subscription request.
assetPermissions	The asset permissions of the subscription request.
assetScopes	The asset scopes of the subscription request.

Value

A list with the following syntax:

list(
  id = "string",
  createdBy = "string",
  updatedBy = "string",
  domainId = "string",
  status = "PENDING"|"ACCEPTED"|"REJECTED",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  requestReason = "string",
  subscribedPrincipals = list(
    list(
      project = list(
        id = "string",
        name = "string"
      ),
      user = list(
        id = "string",
        details = list(
          iam = list(
            arn = "string",
            principalId = "string",
            sessionName = "string",
            groupProfileId = "string"
          ),
          sso = list(
            username = "string",
            firstName = "string",
            lastName = "string"
          )
        )
      ),
      group = list(
        id = "string",
        name = "string"
      ),
      iam = list(
        principalArn = "string"
      )
    )
  ),
  subscribedListings = list(
    list(
      id = "string",
      revision = "string",
      name = "string",
      description = "string",
      item = list(
        assetListing = list(
          entityId = "string",
          entityRevision = "string",
          entityType = "string",
          forms = "string",
          glossaryTerms = list(
            list(
              name = "string",
              shortDescription = "string"
            )
          ),
          assetScope = list(
            assetId = "string",
            filterIds = list(
              "string"
            ),
            status = "string",
            errorMessage = "string"
          ),
          permissions = list(
            s3 = list(
              "READ"|"WRITE"
            )
          )
        ),
        productListing = list(
          entityId = "string",
          entityRevision = "string",
          glossaryTerms = list(
            list(
              name = "string",
              shortDescription = "string"
            )
          ),
          name = "string",
          description = "string",
          assetListings = list(
            list(
              entityId = "string",
              entityRevision = "string",
              entityType = "string"
            )
          )
        )
      ),
      ownerProjectId = "string",
      ownerProjectName = "string"
    )
  ),
  reviewerId = "string",
  decisionComment = "string",
  existingSubscriptionId = "string",
  metadataForms = list(
    list(
      formName = "string",
      typeName = "string",
      typeRevision = "string",
      content = "string"
    )
  )
)

Request syntax

svc$create_subscription_request(
  domainIdentifier = "string",
  subscribedPrincipals = list(
    list(
      project = list(
        identifier = "string"
      ),
      user = list(
        identifier = "string"
      ),
      group = list(
        identifier = "string"
      ),
      iam = list(
        identifier = "string"
      )
    )
  ),
  subscribedListings = list(
    list(
      identifier = "string"
    )
  ),
  requestReason = "string",
  clientToken = "string",
  metadataForms = list(
    list(
      formName = "string",
      typeIdentifier = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  assetPermissions = list(
    list(
      assetId = "string",
      permissions = list(
        s3 = list(
          "READ"|"WRITE"
        )
      )
    )
  ),
  assetScopes = list(
    list(
      assetId = "string",
      filterIds = list(
        "string"
      )
    )
  )
)