Class: Aws::IoTManagedIntegrations::Types::GetAccountAssociationResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTManagedIntegrations::Types::GetAccountAssociationResponse

Defined in:

gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb

Constant Summary

SENSITIVE =

[:o_auth_authorization_url, :tags]

Instance Attribute Summary

• #account_association_id ⇒ String

  The unique identifier of the retrieved account association.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the account association.

• #association_state ⇒ String

  The current status state for the account association.

• #connector_destination_id ⇒ String

  The identifier of the connector destination associated with this account association.

• #description ⇒ String

  The description of the account association.

• #error_message ⇒ String

  The error message explaining the current account association error.

• #general_authorization ⇒ Types::GeneralAuthorizationName

  The General Authorization reference by authorization material name.

• #name ⇒ String

  The name of the account association.

• #o_auth_authorization_url ⇒ String

  Third party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.

• #tags ⇒ Hash<String,String>

  A set of key/value pairs that are used to manage the account association.

Instance Attribute Details

#account_association_id ⇒ String

The unique identifier of the retrieved account association.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the account association.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#association_state ⇒ String

The current status state for the account association.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#connector_destination_id ⇒ String

The identifier of the connector destination associated with this account association.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#description ⇒ String

The description of the account association.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#error_message ⇒ String

The error message explaining the current account association error.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#general_authorization ⇒ Types::GeneralAuthorizationName

The General Authorization reference by authorization material name.

Returns:

• (Types::GeneralAuthorizationName)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#name ⇒ String

The name of the account association.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#o_auth_authorization_url ⇒ String

Third party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication. This field will be empty when using General Authorization flows that do not require OAuth.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A set of key/value pairs that are used to manage the account association.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 1651

class GetAccountAssociationResponse < Struct.new(
  :account_association_id,
  :association_state,
  :error_message,
  :connector_destination_id,
  :name,
  :description,
  :arn,
  :o_auth_authorization_url,
  :tags,
  :general_authorization)
  SENSITIVE = [:o_auth_authorization_url, :tags]
  include Aws::Structure
end