Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RAM.GetResourceShares

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the resource shares that you own or the resource shares that are shared with you.

This operation returns paginated results.

Synopsis

data GetResourceShares = GetResourceShares' {
- tagFilters :: Maybe [TagFilter]
- nextToken :: Maybe Text
- name :: Maybe Text
- resourceShareStatus :: Maybe ResourceShareStatus
- permissionArn :: Maybe Text
- maxResults :: Maybe Natural
- resourceShareArns :: Maybe [Text]
- resourceOwner :: ResourceOwner
}
newGetResourceShares :: ResourceOwner -> GetResourceShares
getResourceShares_tagFilters :: Lens' GetResourceShares (Maybe [TagFilter])
getResourceShares_nextToken :: Lens' GetResourceShares (Maybe Text)
getResourceShares_name :: Lens' GetResourceShares (Maybe Text)
getResourceShares_resourceShareStatus :: Lens' GetResourceShares (Maybe ResourceShareStatus)
getResourceShares_permissionArn :: Lens' GetResourceShares (Maybe Text)
getResourceShares_maxResults :: Lens' GetResourceShares (Maybe Natural)
getResourceShares_resourceShareArns :: Lens' GetResourceShares (Maybe [Text])
getResourceShares_resourceOwner :: Lens' GetResourceShares ResourceOwner
data GetResourceSharesResponse = GetResourceSharesResponse' {
- resourceShares :: Maybe [ResourceShare]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetResourceSharesResponse :: Int -> GetResourceSharesResponse
getResourceSharesResponse_resourceShares :: Lens' GetResourceSharesResponse (Maybe [ResourceShare])
getResourceSharesResponse_nextToken :: Lens' GetResourceSharesResponse (Maybe Text)
getResourceSharesResponse_httpStatus :: Lens' GetResourceSharesResponse Int

Creating a Request

data GetResourceShares Source #

See: newGetResourceShares smart constructor.

Constructors

GetResourceShares'

Fields

tagFilters :: Maybe [TagFilter]
One or more tag filters.
nextToken :: Maybe Text
The token for the next page of results.
name :: Maybe Text
The name of the resource share.
resourceShareStatus :: Maybe ResourceShareStatus
The status of the resource share.
permissionArn :: Maybe Text
The Amazon Resource Name (ARN) of the RAM permission that is associated with the resource share.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
resourceShareArns :: Maybe [Text]
The Amazon Resource Names (ARNs) of the resource shares.
resourceOwner :: ResourceOwner
The type of owner.

Instances

Instances details

Eq GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods (==) :: GetResourceShares -> GetResourceShares -> Bool # (/=) :: GetResourceShares -> GetResourceShares -> Bool #
Read GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods readsPrec :: Int -> ReadS GetResourceShares # readList :: ReadS [GetResourceShares] # readPrec :: ReadPrec GetResourceShares # readListPrec :: ReadPrec [GetResourceShares] #
Show GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods showsPrec :: Int -> GetResourceShares -> ShowS # show :: GetResourceShares -> String # showList :: [GetResourceShares] -> ShowS #
Generic GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Associated Types type Rep GetResourceShares :: Type -> Type # Methods from :: GetResourceShares -> Rep GetResourceShares x # to :: Rep GetResourceShares x -> GetResourceShares #
NFData GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods rnf :: GetResourceShares -> () #
Hashable GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods hashWithSalt :: Int -> GetResourceShares -> Int # hash :: GetResourceShares -> Int #
ToJSON GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods toJSON :: GetResourceShares -> Value # toEncoding :: GetResourceShares -> Encoding # toJSONList :: [GetResourceShares] -> Value # toEncodingList :: [GetResourceShares] -> Encoding #
AWSPager GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods page :: GetResourceShares -> AWSResponse GetResourceShares -> Maybe GetResourceShares #
AWSRequest GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Associated Types type AWSResponse GetResourceShares # Methods request :: GetResourceShares -> Request GetResourceShares # response :: MonadResource m => Logger -> Service -> Proxy GetResourceShares -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResourceShares))) #
ToHeaders GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods toHeaders :: GetResourceShares -> [Header] #
ToPath GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods toPath :: GetResourceShares -> ByteString #
ToQuery GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods toQuery :: GetResourceShares -> QueryString #
type Rep GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares type Rep GetResourceShares = D1 ('MetaData "GetResourceShares" "Amazonka.RAM.GetResourceShares" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "GetResourceShares'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagFilter])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceShareStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceShareStatus)))) :: ((S1 ('MetaSel ('Just "permissionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "resourceShareArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "resourceOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceOwner)))))
type AWSResponse GetResourceShares Source #
Instance details Defined in Amazonka.RAM.GetResourceShares type AWSResponse GetResourceShares = GetResourceSharesResponse

newGetResourceShares Source #

Arguments

:: ResourceOwner	`$sel:resourceOwner:GetResourceShares'`
-> GetResourceShares

Create a value of GetResourceShares with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tagFilters:GetResourceShares', getResourceShares_tagFilters - One or more tag filters.

$sel:nextToken:GetResourceShares', getResourceShares_nextToken - The token for the next page of results.

$sel:name:GetResourceShares', getResourceShares_name - The name of the resource share.

$sel:resourceShareStatus:GetResourceShares', getResourceShares_resourceShareStatus - The status of the resource share.

$sel:permissionArn:GetResourceShares', getResourceShares_permissionArn - The Amazon Resource Name (ARN) of the RAM permission that is associated with the resource share.

$sel:maxResults:GetResourceShares', getResourceShares_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

$sel:resourceShareArns:GetResourceShares', getResourceShares_resourceShareArns - The Amazon Resource Names (ARNs) of the resource shares.

$sel:resourceOwner:GetResourceShares', getResourceShares_resourceOwner - The type of owner.

Request Lenses

getResourceShares_tagFilters :: Lens' GetResourceShares (Maybe [TagFilter]) Source #

One or more tag filters.

getResourceShares_nextToken :: Lens' GetResourceShares (Maybe Text) Source #

The token for the next page of results.

getResourceShares_name :: Lens' GetResourceShares (Maybe Text) Source #

The name of the resource share.

getResourceShares_resourceShareStatus :: Lens' GetResourceShares (Maybe ResourceShareStatus) Source #

The status of the resource share.

getResourceShares_permissionArn :: Lens' GetResourceShares (Maybe Text) Source #

The Amazon Resource Name (ARN) of the RAM permission that is associated with the resource share.

getResourceShares_maxResults :: Lens' GetResourceShares (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

getResourceShares_resourceShareArns :: Lens' GetResourceShares (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) of the resource shares.

getResourceShares_resourceOwner :: Lens' GetResourceShares ResourceOwner Source #

The type of owner.

Destructuring the Response

data GetResourceSharesResponse Source #

See: newGetResourceSharesResponse smart constructor.

Constructors

GetResourceSharesResponse'
Fields resourceShares :: Maybe [ResourceShare] Information about the resource shares. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetResourceSharesResponse Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods (==) :: GetResourceSharesResponse -> GetResourceSharesResponse -> Bool # (/=) :: GetResourceSharesResponse -> GetResourceSharesResponse -> Bool #
Read GetResourceSharesResponse Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods readsPrec :: Int -> ReadS GetResourceSharesResponse # readList :: ReadS [GetResourceSharesResponse] # readPrec :: ReadPrec GetResourceSharesResponse # readListPrec :: ReadPrec [GetResourceSharesResponse] #
Show GetResourceSharesResponse Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods showsPrec :: Int -> GetResourceSharesResponse -> ShowS # show :: GetResourceSharesResponse -> String # showList :: [GetResourceSharesResponse] -> ShowS #
Generic GetResourceSharesResponse Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Associated Types type Rep GetResourceSharesResponse :: Type -> Type # Methods from :: GetResourceSharesResponse -> Rep GetResourceSharesResponse x # to :: Rep GetResourceSharesResponse x -> GetResourceSharesResponse #
NFData GetResourceSharesResponse Source #
Instance details Defined in Amazonka.RAM.GetResourceShares Methods rnf :: GetResourceSharesResponse -> () #
type Rep GetResourceSharesResponse Source #
Instance details Defined in Amazonka.RAM.GetResourceShares type Rep GetResourceSharesResponse = D1 ('MetaData "GetResourceSharesResponse" "Amazonka.RAM.GetResourceShares" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "GetResourceSharesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceShares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceShare])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourceSharesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetResourceSharesResponse'`
-> GetResourceSharesResponse

Create a value of GetResourceSharesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceShares:GetResourceSharesResponse', getResourceSharesResponse_resourceShares - Information about the resource shares.

$sel:nextToken:GetResourceShares', getResourceSharesResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:GetResourceSharesResponse', getResourceSharesResponse_httpStatus - The response's http status code.

Response Lenses

getResourceSharesResponse_resourceShares :: Lens' GetResourceSharesResponse (Maybe [ResourceShare]) Source #

Information about the resource shares.

getResourceSharesResponse_nextToken :: Lens' GetResourceSharesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

getResourceSharesResponse_httpStatus :: Lens' GetResourceSharesResponse Int Source #

The response's http status code.