Skip to content

list_operations async

list_operations(
    *,
    config_overrides: Optional[AsyncRoute53DomainsClientConfig] = None,
    submitted_since: Optional[Timestamp] = None,
    marker: Optional[PageMarker] = None,
    max_items: Optional[PageMaxItems] = None,
    status: Optional[OperationStatusList] = None,
    type: Optional[OperationTypeList] = None,
    sort_by: Optional[ListOperationsSortAttributeName] = None,
    sort_order: Optional[SortOrder] = None,
) -> ListOperationsResponse

Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.

This command runs only in the us-east-1 Region.

Parameters:

  • submitted_since (Optional[Timestamp], default: None ) –

    An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).

  • marker (Optional[PageMarker], default: None ) –

    For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

  • max_items (Optional[PageMaxItems], default: None ) –

    Number of domains to be returned.

    Default: 20

  • status (Optional[OperationStatusList], default: None ) –

    The status of the operations.

  • type (Optional[OperationTypeList], default: None ) –

    An arrays of the domains operation types.

  • sort_by (Optional[ListOperationsSortAttributeName], default: None ) –

    The sort type for returned values.

  • sort_order (Optional[SortOrder], default: None ) –

    The sort order for returned values, either ascending or descending.

Raises:

  • InvalidInput –

    The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

  • UnknownServiceError –

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

Source code in docs_src/capo_route_53_domains/_services/async_route53_domains.py
async def list_operations(
    self,
    *,
    config_overrides: Optional[AsyncRoute53DomainsClientConfig] = None,
    submitted_since: Optional[
        "capo_route_53_domains.types.timestamp.Timestamp"
    ] = None,
    marker: Optional["capo_route_53_domains.types.page_marker.PageMarker"] = None,
    max_items: Optional[
        "capo_route_53_domains.types.page_max_items.PageMaxItems"
    ] = None,
    status: Optional[
        "capo_route_53_domains.types.operation_status_list.OperationStatusList"
    ] = None,
    type: Optional[
        "capo_route_53_domains.types.operation_type_list.OperationTypeList"
    ] = None,
    sort_by: Optional[
        "capo_route_53_domains.types.list_operations_sort_attribute_name.ListOperationsSortAttributeName"
    ] = None,
    sort_order: Optional["capo_route_53_domains.types.sort_order.SortOrder"] = None,
) -> "capo_route_53_domains.types.list_operations_response.ListOperationsResponse":
    """<p>Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account. </p> <p>This command runs only in the us-east-1 Region.</p>

    Args:
        submitted_since: <p>An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).</p>
        marker: <p>For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional operations. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element.</p>
        max_items: <p>Number of domains to be returned.</p> <p>Default: 20</p>
        status: <p> The status of the operations. </p>
        type: <p> An arrays of the domains operation types. </p>
        sort_by: <p> The sort type for returned values. </p>
        sort_order: <p> The sort order for returned values, either ascending or descending. </p>

    Raises:
        capo_route_53_domains.errors.invalid_input.InvalidInput: <p>The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For <code>AcceptDomainTransferFromAnotherAwsAccount</code>, the password might be invalid.</p>
        capo_route_53_domains.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_route_53_domains.types.list_operations_request.ListOperationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_route_53_domains.types.list_operations_response.ListOperationsResponse"
    ]:
        import capo_route_53_domains._operations.route53_domains_v20140515.list_operations

        (
            output,
            http_response,
        ) = await capo_route_53_domains._operations.route53_domains_v20140515.list_operations.async_list_operations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListOperations")
    )
    input_: capo_route_53_domains.types.list_operations_request.ListOperationsRequest = {}
    if submitted_since is not None:
        input_["submitted_since"] = submitted_since
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items
    if status is not None:
        input_["status"] = status
    if type is not None:
        input_["type"] = type
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order

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