Skip to content

list_packages_for_domain

list_packages_for_domain(
    domain_name: DomainName,
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListPackagesForDomainResponse

Lists all packages associated with the Amazon ES domain.

Parameters:

  • domain_name (DomainName) –

    The name of the domain for which you want to list associated packages.

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

    Limits results to a maximum number of packages.

  • 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/elasticsearch_service.py
def list_packages_for_domain(
    self,
    domain_name: "capo_elasticsearch_service.types.domain_name.DomainName",
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = 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_packages_for_domain_response.ListPackagesForDomainResponse":
    """<p>Lists all packages associated with the Amazon ES domain.</p>

    Args:
        domain_name: <p>The name of the domain for which you want to list associated packages.</p>
        max_results: <p>Limits results to a maximum number of packages.</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.
    """

    def _handler(
        req: "OperationRequest[capo_elasticsearch_service.types.list_packages_for_domain_request.ListPackagesForDomainRequest]",
    ) -> OperationResponse[
        "capo_elasticsearch_service.types.list_packages_for_domain_response.ListPackagesForDomainResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.list_packages_for_domain

        output, http_response = (
            capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.list_packages_for_domain.list_packages_for_domain(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPackagesForDomain")
    )
    input_: capo_elasticsearch_service.types.list_packages_for_domain_request.ListPackagesForDomainRequest = {
        "domain_name": domain_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output