DataZone / Client / create_subscription_target

create_subscription_target

DataZone.Client.create_subscription_target(**kwargs)

Creates a subscription target in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.create_subscription_target(
    domainIdentifier='string',
    environmentIdentifier='string',
    name='string',
    type='string',
    subscriptionTargetConfig=[
        {
            'formName': 'string',
            'content': 'string'
        },
    ],
    authorizedPrincipals=[
        'string',
    ],
    manageAccessRole='string',
    applicableAssetTypes=[
        'string',
    ],
    provider='string',
    clientToken='string',
    subscriptionGrantCreationMode='AUTOMATIC'|'MANUAL'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the Amazon DataZone domain in which subscription target is created.

• environmentIdentifier (string) –

  [REQUIRED]

  The ID of the environment in which subscription target is created.

• name (string) –

  [REQUIRED]

  The name of the subscription target.

• type (string) –

  [REQUIRED]

  The type of the subscription target.

• subscriptionTargetConfig (list) –

  [REQUIRED]

  The configuration of the subscription target.

  • (dict) –

    The details of the subscription target configuration.

    • formName (string) – [REQUIRED]

      The form name included in the subscription target configuration.

    • content (string) – [REQUIRED]

      The content of the subscription target configuration.

• authorizedPrincipals (list) –

  [REQUIRED]

  The authorized principals of the subscription target.

  • (string) –

• manageAccessRole (string) –

  [REQUIRED]

  The manage access role that is used to create the subscription target.

• applicableAssetTypes (list) –

  [REQUIRED]

  The asset types that can be included in the subscription target.

  • (string) –

• provider (string) – The provider of the subscription target.

• clientToken (string) –

  A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

  This field is autopopulated if not provided.

• subscriptionGrantCreationMode (string) – Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'authorizedPrincipals': [
        'string',
    ],
    'domainId': 'string',
    'projectId': 'string',
    'environmentId': 'string',
    'name': 'string',
    'type': 'string',
    'createdBy': 'string',
    'updatedBy': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'manageAccessRole': 'string',
    'applicableAssetTypes': [
        'string',
    ],
    'subscriptionTargetConfig': [
        {
            'formName': 'string',
            'content': 'string'
        },
    ],
    'provider': 'string',
    'subscriptionGrantCreationMode': 'AUTOMATIC'|'MANUAL'
}

Response Structure

• (dict) –

  • id (string) –

    The ID of the subscription target.

  • authorizedPrincipals (list) –

    The authorised principals of the subscription target.

    • (string) –

  • domainId (string) –

    The ID of the Amazon DataZone domain in which the subscription target was created.

  • projectId (string) –

    ???

  • environmentId (string) –

    The ID of the environment in which the subscription target was created.

  • name (string) –

    The name of the subscription target.

  • type (string) –

    The type of the subscription target.

  • createdBy (string) –

    The Amazon DataZone user who created the subscription target.

  • updatedBy (string) –

    The Amazon DataZone user who updated the subscription target.

  • createdAt (datetime) –

    The timestamp of when the subscription target was created.

  • updatedAt (datetime) –

    The timestamp of when the subscription target was updated.

  • manageAccessRole (string) –

    The manage access role with which the subscription target was created.

  • applicableAssetTypes (list) –

    The asset types that can be included in the subscription target.

    • (string) –

  • subscriptionTargetConfig (list) –

    The configuration of the subscription target.

    • (dict) –

      The details of the subscription target configuration.

      • formName (string) –

        The form name included in the subscription target configuration.

      • content (string) –

        The content of the subscription target configuration.

  • provider (string) –

    The provider of the subscription target.

  • subscriptionGrantCreationMode (string) –

    Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException