Skip to content

DescribedProfile

Source code in docs_src/capo_transfer/types/described_profile.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
class DescribedProfile(TypedDict, closed=True):
    arn: "capo_transfer.types.arn.Arn"
    """<p>The unique Amazon Resource Name (ARN) for the profile.</p>"""
    profile_id: NotRequired["capo_transfer.types.profile_id.ProfileId"]
    """<p>A unique identifier for the local or partner AS2 profile.</p>"""
    profile_type: NotRequired["capo_transfer.types.profile_type.ProfileType"]
    """<p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles. If not supplied in the request, the command lists all types of profiles.</p>"""
    as2_id: NotRequired["capo_transfer.types.as2_id.As2Id"]
    """<p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>"""
    certificate_ids: NotRequired["capo_transfer.types.certificate_ids.CertificateIds"]
    """<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for profiles.</p>"""

arn instance-attribute 

arn: Arn

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

as2_id instance-attribute 

as2_id: NotRequired[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.

certificate_ids instance-attribute 

certificate_ids: NotRequired[CertificateIds]

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

profile_id instance-attribute 

profile_id: NotRequired[ProfileId]

A unique identifier for the local or partner AS2 profile.

profile_type instance-attribute 

profile_type: NotRequired[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.

tags instance-attribute 

tags: NotRequired[Tags]

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