Class: Aws::RAM::Types::GetResourceSharesRequest

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

Overview

Note:

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

{
  resource_share_arns: ["String"],
  resource_share_status: "PENDING", # accepts PENDING, ACTIVE, FAILED, DELETING, DELETED
  resource_owner: "SELF", # required, accepts SELF, OTHER-ACCOUNTS
  name: "String",
  tag_filters: [
    {
      tag_key: "TagKey",
      tag_values: ["TagValue"],
    },
  ],
  next_token: "String",
  max_results: 1,
  permission_arn: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Specifies the name of an individual resource share that you want to retrieve details about.

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  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)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  SENSITIVE = []
  include Aws::Structure
end

#permission_arnString

Specifies that you want to retrieve details of only those resource shares that use the RAM permission with this Amazon Resoure Name (ARN).

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_ownerString

Specifies that you want to retrieve details of only those resource shares that match the following:

  • SELF – resource shares that your account shares with other accounts

  • OTHER-ACCOUNTS – resource shares that other accounts share with your account

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_arnsArray<String>

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

Returns:

  • (Array<String>)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_statusString

Specifies that you want to retrieve details of only those resource shares that have this status.

Returns:

  • (String)


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tag_filtersArray<Types::TagFilter>

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Returns:



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 1126

class GetResourceSharesRequest < Struct.new(
  :resource_share_arns,
  :resource_share_status,
  :resource_owner,
  :name,
  :tag_filters,
  :next_token,
  :max_results,
  :permission_arn)
  SENSITIVE = []
  include Aws::Structure
end