Skip to content

describe_profile

describe_profile(
    profile_id: ProfileId, *, config_overrides: Optional[TransferClientConfig] = None
) -> DescribeProfileResponse

Returns the details of the profile that's specified by the ProfileId.

Parameters:

  • profile_id (ProfileId) –

    The identifier of the profile that you want described.

Raises:

Source code in docs_src/capo_transfer/_services/transfer.py
def describe_profile(
    self,
    profile_id: "capo_transfer.types.profile_id.ProfileId",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
) -> "capo_transfer.types.describe_profile_response.DescribeProfileResponse":
    """<p>Returns the details of the profile that's specified by the <code>ProfileId</code>.</p>

    Args:
        profile_id: <p>The identifier of the profile that you want described.</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.describe_profile_request.DescribeProfileRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.describe_profile_response.DescribeProfileResponse"
    ]:
        import capo_transfer._operations.transfer_service.describe_profile

        output, http_response = (
            capo_transfer._operations.transfer_service.describe_profile.describe_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeProfile")
    )
    input_: capo_transfer.types.describe_profile_request.DescribeProfileRequest = {
        "profile_id": profile_id
    }

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