create_environment_action `async` ¶

create_environment_action(
    domain_identifier: DomainId,
    environment_identifier: EnvironmentId,
    name: str,
    parameters: ActionParameters,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    description: Optional[str] = None,
) -> CreateEnvironmentActionOutput

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

Parameters:

domain_identifier (DomainId) –

The ID of the Amazon DataZone domain in which the environment action is created.
environment_identifier (EnvironmentId) –

The ID of the environment in which the environment action is created.
name (str) –

The name of the environment action.
parameters (ActionParameters) –

The parameters of the environment action.
description (Optional[str], default: None ) –

The description of the environment action that is being created in the environment.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ThrottlingException –

The request was denied due to request throttling.
UnauthorizedException –

You do not have permission to perform this action.
ConflictException –

There is a conflict while performing this action.
InternalServerException –

The request has failed because of an unknown error, exception or failure.
ResourceNotFoundException –

The specified resource cannot be found.
ValidationException –

The input fails to satisfy the constraints specified by the Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_datazone/_services/async_data_zone.py

async def create_environment_action(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    environment_identifier: "capo_datazone.types.environment_id.EnvironmentId",
    name: str,
    parameters: "capo_datazone.types.action_parameters.ActionParameters",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    description: Optional[str] = None,
) -> "capo_datazone.types.create_environment_action_output.CreateEnvironmentActionOutput":
    """<p>Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.</p>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain in which the environment action is created.</p>
        environment_identifier: <p>The ID of the environment in which the environment action is created.</p>
        name: <p>The name of the environment action.</p>
        parameters: <p>The parameters of the environment action.</p>
        description: <p>The description of the environment action that is being created in the environment.</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.create_environment_action_input.CreateEnvironmentActionInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.create_environment_action_output.CreateEnvironmentActionOutput"
    ]:
        import capo_datazone._operations.data_zone.create_environment_action

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateEnvironmentAction")
    )
    input_: capo_datazone.types.create_environment_action_input.CreateEnvironmentActionInput = {
        "domain_identifier": domain_identifier,
        "environment_identifier": environment_identifier,
        "name": name,
        "parameters": parameters,
    }
    if description is not None:
        input_["description"] = description

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

create_environment_action async ¶

create_environment_action `async` ¶