describe_role_alias ¶

describe_role_alias(
    role_alias: RoleAlias, *, config_overrides: Optional[IoTClientConfig] = None
) -> DescribeRoleAliasResponse

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

Parameters:

role_alias (RoleAlias) –

The role alias to describe.

Raises:

InternalFailureException –

An unexpected error has occurred.
InvalidRequestException –

The request is not valid.
ResourceNotFoundException –

The specified resource does not exist.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The rate exceeds the limit.
UnauthorizedException –

You are not authorized to perform this operation.
UnknownServiceError –

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

Source code in docs_src/capo_iot/_services/io_t.py

def describe_role_alias(
    self,
    role_alias: "capo_iot.types.role_alias.RoleAlias",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.describe_role_alias_response.DescribeRoleAliasResponse":
    """<p>Describes a role alias.</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">DescribeRoleAlias</a> action.</p>

    Args:
        role_alias: <p>The role alias to describe.</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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</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.describe_role_alias_request.DescribeRoleAliasRequest]",
    ) -> OperationResponse[
        "capo_iot.types.describe_role_alias_response.DescribeRoleAliasResponse"
    ]:
        import capo_iot._operations.aws_iot_service.describe_role_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRoleAlias")
    )
    input_: capo_iot.types.describe_role_alias_request.DescribeRoleAliasRequest = {
        "role_alias": role_alias
    }

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