Class: Aws::Transfer::Types::DescribedProfile

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transfer/types.rb

Overview

The details for a local or partner AS2 profile.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
# File 'lib/aws-sdk-transfer/types.rb', line 2443

class DescribedProfile < Struct.new(
  :arn,
  :profile_id,
  :profile_type,
  :as_2_id,
  :certificate_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#as_2_idString

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.

[1]: datatracker.ietf.org/doc/html/rfc4130

Returns:

  • (String)


2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
# File 'lib/aws-sdk-transfer/types.rb', line 2443

class DescribedProfile < Struct.new(
  :arn,
  :profile_id,
  :profile_type,
  :as_2_id,
  :certificate_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_idsArray<String>

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

Returns:

  • (Array<String>)


2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
# File 'lib/aws-sdk-transfer/types.rb', line 2443

class DescribedProfile < Struct.new(
  :arn,
  :profile_id,
  :profile_type,
  :as_2_id,
  :certificate_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#profile_idString

A unique identifier for the local or partner AS2 profile.

Returns:

  • (String)


2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
# File 'lib/aws-sdk-transfer/types.rb', line 2443

class DescribedProfile < Struct.new(
  :arn,
  :profile_id,
  :profile_type,
  :as_2_id,
  :certificate_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#profile_typeString

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.

Returns:

  • (String)


2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
# File 'lib/aws-sdk-transfer/types.rb', line 2443

class DescribedProfile < Struct.new(
  :arn,
  :profile_id,
  :profile_type,
  :as_2_id,
  :certificate_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
# File 'lib/aws-sdk-transfer/types.rb', line 2443

class DescribedProfile < Struct.new(
  :arn,
  :profile_id,
  :profile_type,
  :as_2_id,
  :certificate_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end