Skip to content

list_environment_actions async

list_environment_actions(
    domain_identifier: DomainId,
    environment_identifier: EnvironmentId,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListEnvironmentActionsOutput

Lists existing environment actions.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the Amazon DataZone domain in which the environment actions are listed.

  • environment_identifier (EnvironmentId) –

    The ID of the envrironment whose environment actions are listed.

  • next_token (Optional[PaginationToken], default: None ) –

    When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of environment actions to return in a single call to ListEnvironmentActions. When the number of environment actions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

Raises:

Source code in docs_src/capo_datazone/_services/async_data_zone.py
async def list_environment_actions(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    environment_identifier: "capo_datazone.types.environment_id.EnvironmentId",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
) -> "capo_datazone.types.list_environment_actions_output.ListEnvironmentActionsOutput":
    """<p>Lists existing environment actions.</p>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain in which the environment actions are listed.</p>
        environment_identifier: <p>The ID of the envrironment whose environment actions are listed.</p>
        next_token: <p>When the number of environment actions is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of environment actions, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListEnvironmentActions</code> to list the next set of environment actions.</p>
        max_results: <p>The maximum number of environment actions to return in a single call to <code>ListEnvironmentActions</code>. When the number of environment actions to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListEnvironmentActions</code> to list the next set of environment actions.</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.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</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.list_environment_actions_input.ListEnvironmentActionsInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.list_environment_actions_output.ListEnvironmentActionsOutput"
    ]:
        import capo_datazone._operations.data_zone.list_environment_actions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEnvironmentActions")
    )
    input_: capo_datazone.types.list_environment_actions_input.ListEnvironmentActionsInput = {
        "domain_identifier": domain_identifier,
        "environment_identifier": environment_identifier,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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