list_domains_for_package `async` ¶

list_domains_for_package(
    package_id: PackageID,
    *,
    config_overrides: Optional[AsyncElasticsearchServiceClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListDomainsForPackageResponse

Lists all Amazon ES domains associated with the package.

Parameters:

package_id (PackageID) –

The package for which to list domains.
max_results (Optional[MaxResults], default: None ) –

Limits results to a maximum number of domains.
next_token (Optional[NextToken], default: None ) –

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Raises:

AccessDeniedException –

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
BaseException –

An error occurred while processing the request.
InternalException –

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException –

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException –

An exception for missing / invalid input fields. Gives http status code of 400.
UnknownServiceError –

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

Source code in docs_src/capo_elasticsearch_service/_services/async_elasticsearch_service.py

async def list_domains_for_package(
    self,
    package_id: "capo_elasticsearch_service.types.package_id.PackageID",
    *,
    config_overrides: Optional[AsyncElasticsearchServiceClientConfig] = None,
    max_results: Optional[
        "capo_elasticsearch_service.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_elasticsearch_service.types.next_token.NextToken"
    ] = None,
) -> "capo_elasticsearch_service.types.list_domains_for_package_response.ListDomainsForPackageResponse":
    """<p>Lists all Amazon ES domains associated with the package.</p>

    Args:
        package_id: <p>The package for which to list domains.</p>
        max_results: <p>Limits results to a maximum number of domains.</p>
        next_token: <p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>

    Raises:
        capo_elasticsearch_service.errors.access_denied_exception.AccessDeniedException: <p>An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.</p>
        capo_elasticsearch_service.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_elasticsearch_service.errors.internal_exception.InternalException: <p>The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.</p>
        capo_elasticsearch_service.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>
        capo_elasticsearch_service.errors.validation_exception.ValidationException: <p>An exception for missing / invalid input fields. Gives http status code of 400.</p>
        capo_elasticsearch_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_elasticsearch_service.types.list_domains_for_package_request.ListDomainsForPackageRequest]",
    ) -> AsyncOperationResponse[
        "capo_elasticsearch_service.types.list_domains_for_package_response.ListDomainsForPackageResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.list_domains_for_package

        (
            output,
            http_response,
        ) = await capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.list_domains_for_package.async_list_domains_for_package(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDomainsForPackage")
    )
    input_: capo_elasticsearch_service.types.list_domains_for_package_request.ListDomainsForPackageRequest = {
        "package_id": package_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_domains_for_package async ¶

list_domains_for_package `async` ¶