DescribeProfile - AWS Transfer Family

DescribeProfile

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

Request Syntax

{ "ProfileId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ProfileId

The identifier of the profile that you want described.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^p-([0-9a-f]{17})$

Required: Yes

Response Syntax

{ "Profile": { "Arn": "string", "As2Id": "string", "CertificateIds": [ "string" ], "ProfileId": "string", "ProfileType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Profile

The details of the specified profile, returned as an object.

Type: DescribedProfile object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWSTransfer Family service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWSTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWSTransfer Family service is not available.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: