DescribedProfile - AWS Transfer Family

DescribedProfile

The details for a local or partner AS2 profile.

Contents

Arn

The unique Amazon Resource Name (ARN) for the profile.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:\S+

Required: Yes

As2Id

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{Print}\s]*

Required: No

CertificateIds

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Type: Array of strings

Length Constraints: Fixed length of 22.

Pattern: cert-([0-9a-f]{17})

Required: No

ProfileId

A unique identifier for the local or partner AS2 profile.

Type: String

Length Constraints: Fixed length of 19.

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

Required: No

ProfileType

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Type: String

Valid Values: LOCAL | PARTNER

Required: No

Tags

Key-value pairs that can be used to group and search for profiles.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

See Also

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