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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#association_statusString

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

Returns:

  • (String)


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# 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_typeString

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)


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# 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_resultsInteger

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)


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# 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_tokenString

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)


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# 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

#principalString

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)


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# 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_arnString

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)


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# 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_arnsArray<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>)


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# 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