Class: Aws::RAM::Types::GetResourceShareAssociationsRequest

Inherits:

Struct

• Object
• Struct
• Aws::RAM::Types::GetResourceShareAssociationsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ram/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #association_status ⇒ String

  Specifies that you want to retrieve only associations that have this status.

• #association_type ⇒ String

  Specifies whether you want to retrieve the associations that involve a specified resource or principal.

• #max_results ⇒ Integer

  Specifies the total number of results that you want included on each page of the response.

• #next_token ⇒ String

  Specifies that you want to receive the next page of results.

• #principal ⇒ String

  Specifies the ID of the principal whose resource shares you want to retrieve.

• #resource_arn ⇒ String

  Specifies the [Amazon Resource Name (ARN)] of a resource whose resource shares you want to retrieve.

• #resource_share_arns ⇒ Array<String>

  Specifies a list of [Amazon Resource Names (ARNs)] of the resource share whose associations you want to retrieve.

Instance Attribute Details

#association_status ⇒ String

Specifies that you want to retrieve only associations that have this status.

Returns:

• (String)

# File 'lib/aws-sdk-ram/types.rb', line 1316

class GetResourceShareAssociationsRequest < Struct.new(
  :association_type,
  :resource_share_arns,
  :resource_arn,
  :principal,
  :association_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#association_type ⇒ String

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

• ‘PRINCIPAL` – list the principals whose associations you want to see.

• ‘RESOURCE` – list the resources whose associations you want to see.

Returns:

• (String)

# File 'lib/aws-sdk-ram/types.rb', line 1316

class GetResourceShareAssociationsRequest < Struct.new(
  :association_type,
  :resource_share_arns,
  :resource_arn,
  :principal,
  :association_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the ‘NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

Returns:

• (Integer)

# File 'lib/aws-sdk-ram/types.rb', line 1316

class GetResourceShareAssociationsRequest < Struct.new(
  :association_type,
  :resource_share_arns,
  :resource_arn,
  :principal,
  :association_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Specifies that you want to receive the next page of results. Valid only if you received a ‘NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s ‘NextToken` response to request the next page of results.

Returns:

• (String)

# File 'lib/aws-sdk-ram/types.rb', line 1316

class GetResourceShareAssociationsRequest < Struct.new(
  :association_type,
  :resource_share_arns,
  :resource_arn,
  :principal,
  :association_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#principal ⇒ String

Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the [Amazon Resource Name (ARN)] of an individual IAM role or user.

You cannot specify this parameter if the association type is ‘RESOURCE`.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-ram/types.rb', line 1316

class GetResourceShareAssociationsRequest < Struct.new(
  :association_type,
  :resource_share_arns,
  :resource_arn,
  :principal,
  :association_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

Specifies the [Amazon Resource Name (ARN)] of a resource whose resource shares you want to retrieve.

You cannot specify this parameter if the association type is ‘PRINCIPAL`.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-ram/types.rb', line 1316

class GetResourceShareAssociationsRequest < Struct.new(
  :association_type,
  :resource_share_arns,
  :resource_arn,
  :principal,
  :association_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_arns ⇒ Array<String>

Specifies a list of [Amazon Resource Names (ARNs)] of the resource share whose associations you want to retrieve.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ram/types.rb', line 1316

class GetResourceShareAssociationsRequest < Struct.new(
  :association_type,
  :resource_share_arns,
  :resource_arn,
  :principal,
  :association_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end