Skip to content

list_domain_configurations

list_domain_configurations(
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    marker: Optional[Marker] = None,
    page_size: Optional[PageSize] = None,
    service_type: Optional[ServiceType] = None,
) -> ListDomainConfigurationsResponse

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Requires permission to access the ListDomainConfigurations action.

Parameters:

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

    The marker for the next set of results.

  • page_size (Optional[PageSize], default: None ) –

    The result page size.

  • service_type (Optional[ServiceType], default: None ) –

    The type of service delivered by the endpoint.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def list_domain_configurations(
    self,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    marker: Optional["capo_iot.types.marker.Marker"] = None,
    page_size: Optional["capo_iot.types.page_size.PageSize"] = None,
    service_type: Optional["capo_iot.types.service_type.ServiceType"] = None,
) -> "capo_iot.types.list_domain_configurations_response.ListDomainConfigurationsResponse":
    """<p>Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListDomainConfigurations</a> action.</p>

    Args:
        marker: <p>The marker for the next set of results.</p>
        page_size: <p>The result page size.</p>
        service_type: <p>The type of service delivered by the endpoint.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.list_domain_configurations_request.ListDomainConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_iot.types.list_domain_configurations_response.ListDomainConfigurationsResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_domain_configurations

        output, http_response = (
            capo_iot._operations.aws_iot_service.list_domain_configurations.list_domain_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDomainConfigurations")
    )
    input_: capo_iot.types.list_domain_configurations_request.ListDomainConfigurationsRequest = {}
    if marker is not None:
        input_["marker"] = marker
    if page_size is not None:
        input_["page_size"] = page_size
    if service_type is not None:
        input_["service_type"] = service_type

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