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

Inherits:

Struct

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

Defined in:

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

Overview

Note:

When making an API call, you may pass GetResourceShareAssociationsRequest data as a hash:

{
  association_type: "PRINCIPAL", # required, accepts PRINCIPAL, RESOURCE
  resource_share_arns: ["String"],
  resource_arn: "String",
  principal: "String",
  association_status: "ASSOCIATING", # accepts ASSOCIATING, ASSOCIATED, FAILED, DISASSOCIATING, DISASSOCIATED
  next_token: "String",
  max_results: 1,
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #association_status ⇒ String

  Specifies that you want to retrieve only associations with 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 Resoure Name (ARN)][1] of the resource whose resource shares you want to retrieve.

• #resource_share_arns ⇒ Array<String>

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

Instance Attribute Details

#association_status ⇒ String

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

Returns:

• (String)

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

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 that are associated with the specified resource share.

• RESOURCE – list the resources that are associated with the specified resource share.

Returns:

• (String)

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

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 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 922

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 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 922

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 Resoure Name (ARN) of an individual IAM user or role.

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

Returns:

• (String)

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

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 Resoure Name (ARN) of the resource whose resource shares you want to retrieve.

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

Returns:

• (String)

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

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.

Returns:

• (Array<String>)

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

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