get_saml_provider ¶

get_saml_provider(
    saml_provider_arn: arnType, *, config_overrides: Optional[IAMClientConfig] = None
) -> GetSAMLProviderResponse

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

This operation requires Signature Version 4.

Parameters:

saml_provider_arn (arnType) –

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Raises:

InvalidInputException –

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
NoSuchEntityException –

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException –

The request processing has failed because of an unknown error, exception or failure.
UnknownServiceError –

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

Source code in docs_src/capo_iam/_services/iam.py

def get_saml_provider(
    self,
    saml_provider_arn: "capo_iam.types.arn_type.arnType",
    *,
    config_overrides: Optional[IAMClientConfig] = None,
) -> "capo_iam.types.get_saml_provider_response.GetSAMLProviderResponse":
    """<p>Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.</p> <note> <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note>

    Args:
        saml_provider_arn: <p>The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>

    Raises:
        capo_iam.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iam.types.get_saml_provider_request.GetSAMLProviderRequest]",
    ) -> OperationResponse[
        "capo_iam.types.get_saml_provider_response.GetSAMLProviderResponse"
    ]:
        import capo_iam._operations.aws_identity_management_v20100508.get_saml_provider

        output, http_response = (
            capo_iam._operations.aws_identity_management_v20100508.get_saml_provider.get_saml_provider(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSAMLProvider")
    )
    input_: capo_iam.types.get_saml_provider_request.GetSAMLProviderRequest = {
        "saml_provider_arn": saml_provider_arn
    }

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