Skip to content

update_subscription_target async

update_subscription_target(
    domain_identifier: DomainId,
    environment_identifier: EnvironmentId,
    identifier: SubscriptionTargetId,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    name: Optional[SubscriptionTargetName] = None,
    authorized_principals: Optional[AuthorizedPrincipalIdentifiers] = None,
    applicable_asset_types: Optional[ApplicableAssetTypes] = None,
    subscription_target_config: Optional[SubscriptionTargetForms] = None,
    manage_access_role: Optional[IamRoleArn] = None,
    provider: Optional[str] = None,
    subscription_grant_creation_mode: Optional[SubscriptionGrantCreationMode] = None,
) -> UpdateSubscriptionTargetOutput

Updates the specified subscription target in Amazon DataZone.

Parameters:

  • domain_identifier (DomainId) –

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

  • environment_identifier (EnvironmentId) –

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

  • identifier (SubscriptionTargetId) –

    Identifier of the subscription target that is to be updated.

  • name (Optional[SubscriptionTargetName], default: None ) –

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

  • authorized_principals (Optional[AuthorizedPrincipalIdentifiers], default: None ) –

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

  • applicable_asset_types (Optional[ApplicableAssetTypes], default: None ) –

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

  • subscription_target_config (Optional[SubscriptionTargetForms], default: None ) –

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

  • manage_access_role (Optional[IamRoleArn], default: None ) –

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

  • provider (Optional[str], default: None ) –

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

  • subscription_grant_creation_mode (Optional[SubscriptionGrantCreationMode], default: None ) –

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

Raises:

Source code in docs_src/capo_datazone/_services/async_data_zone.py
async def update_subscription_target(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    environment_identifier: "capo_datazone.types.environment_id.EnvironmentId",
    identifier: "capo_datazone.types.subscription_target_id.SubscriptionTargetId",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    name: Optional[
        "capo_datazone.types.subscription_target_name.SubscriptionTargetName"
    ] = None,
    authorized_principals: Optional[
        "capo_datazone.types.authorized_principal_identifiers.AuthorizedPrincipalIdentifiers"
    ] = None,
    applicable_asset_types: Optional[
        "capo_datazone.types.applicable_asset_types.ApplicableAssetTypes"
    ] = None,
    subscription_target_config: Optional[
        "capo_datazone.types.subscription_target_forms.SubscriptionTargetForms"
    ] = None,
    manage_access_role: Optional[
        "capo_datazone.types.iam_role_arn.IamRoleArn"
    ] = None,
    provider: Optional[str] = None,
    subscription_grant_creation_mode: Optional[
        "capo_datazone.types.subscription_grant_creation_mode.SubscriptionGrantCreationMode"
    ] = None,
) -> "capo_datazone.types.update_subscription_target_output.UpdateSubscriptionTargetOutput":
    """<p>Updates the specified subscription target in Amazon DataZone.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain in which a subscription target is to be updated.</p>
        environment_identifier: <p>The identifier of the environment in which a subscription target is to be updated.</p>
        identifier: <p>Identifier of the subscription target that is to be updated.</p>
        name: <p>The name to be updated as part of the <code>UpdateSubscriptionTarget</code> action.</p>
        authorized_principals: <p>The authorized principals to be updated as part of the <code>UpdateSubscriptionTarget</code> action.</p>
        applicable_asset_types: <p>The applicable asset types to be updated as part of the <code>UpdateSubscriptionTarget</code> action.</p>
        subscription_target_config: <p>The configuration to be updated as part of the <code>UpdateSubscriptionTarget</code> action.</p>
        manage_access_role: <p>The manage access role to be updated as part of the <code>UpdateSubscriptionTarget</code> action.</p>
        provider: <p>The provider to be updated as part of the <code>UpdateSubscriptionTarget</code> action.</p>
        subscription_grant_creation_mode: <p> Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually. </p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.conflict_exception.ConflictException: <p>There is a conflict while performing this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.update_subscription_target_input.UpdateSubscriptionTargetInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.update_subscription_target_output.UpdateSubscriptionTargetOutput"
    ]:
        import capo_datazone._operations.data_zone.update_subscription_target

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.update_subscription_target.async_update_subscription_target(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_datazone.types.update_subscription_target_input.UpdateSubscriptionTargetInput",
    ) -> dict[str, Any]:
        import capo_datazone.types.update_subscription_target_input

        return (
            capo_datazone.types.update_subscription_target_input.redact_sensitive(
                input_
            )
        )

    def _redact_output(
        output: "capo_datazone.types.update_subscription_target_output.UpdateSubscriptionTargetOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.update_subscription_target_output

        return (
            capo_datazone.types.update_subscription_target_output.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateSubscriptionTarget",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_datazone.types.update_subscription_target_input.UpdateSubscriptionTargetInput = {
        "domain_identifier": domain_identifier,
        "environment_identifier": environment_identifier,
        "identifier": identifier,
    }
    if name is not None:
        input_["name"] = name
    if authorized_principals is not None:
        input_["authorized_principals"] = authorized_principals
    if applicable_asset_types is not None:
        input_["applicable_asset_types"] = applicable_asset_types
    if subscription_target_config is not None:
        input_["subscription_target_config"] = subscription_target_config
    if manage_access_role is not None:
        input_["manage_access_role"] = manage_access_role
    if provider is not None:
        input_["provider"] = provider
    if subscription_grant_creation_mode is not None:
        input_["subscription_grant_creation_mode"] = (
            subscription_grant_creation_mode
        )

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output