DataZone / Client / update_subscription_target

update_subscription_target

DataZone.Client.update_subscription_target(**kwargs)

Updates the specified subscription target in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

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

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

  • environmentIdentifier (string) –

    [REQUIRED]

    The identifier of the environment in which a subscription target is to be updated.

  • identifier (string) –

    [REQUIRED]

    Identifier of the subscription target that is to be updated.

  • name (string) – The name to be updated as part of the UpdateSubscriptionTarget action.

  • authorizedPrincipals (list) –

    The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

    • (string) –

  • applicableAssetTypes (list) –

    The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

    • (string) –

  • subscriptionTargetConfig (list) –

    The configuration to be updated as part of the UpdateSubscriptionTarget action.

    • (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.

  • manageAccessRole (string) – The manage access role to be updated as part of the UpdateSubscriptionTarget action.

  • provider (string) – The provider to be updated as part of the UpdateSubscriptionTarget action.

  • 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) –

      Identifier of the subscription target that is to be updated.

    • authorizedPrincipals (list) –

      The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.

      • (string) –

    • domainId (string) –

      The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

    • projectId (string) –

      The identifier of the project in which a subscription target is to be updated.

    • environmentId (string) –

      The identifier of the environment in which a subscription target is to be updated.

    • name (string) –

      The name to be updated as part of the UpdateSubscriptionTarget action.

    • type (string) –

      The type to be updated as part of the UpdateSubscriptionTarget action.

    • 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 a subscription target was created.

    • updatedAt (datetime) –

      The timestamp of when the subscription target was updated.

    • manageAccessRole (string) –

      The manage access role to be updated as part of the UpdateSubscriptionTarget action.

    • applicableAssetTypes (list) –

      The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

      • (string) –

    • subscriptionTargetConfig (list) –

      The configuration to be updated as part of the UpdateSubscriptionTarget action.

      • (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 to be updated as part of the UpdateSubscriptionTarget action.

    • subscriptionGrantCreationMode (string) –

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

Exceptions