amazonka-ram-2.0: Amazon Resource Access Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RAM.GetResourceShareInvitations

Description

Retrieves details about invitations that you have received for resource shares.

This operation returns paginated results.

Synopsis

Creating a Request

data GetResourceShareInvitations Source #

See: newGetResourceShareInvitations smart constructor.

Constructors

GetResourceShareInvitations' 

Fields

  • maxResults :: Maybe Natural

    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.

  • nextToken :: Maybe Text

    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.

  • resourceShareArns :: Maybe [Text]

    Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

  • resourceShareInvitationArns :: Maybe [Text]

    Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

Instances

Instances details
ToJSON GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

ToHeaders GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

ToPath GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

ToQuery GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

AWSPager GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

AWSRequest GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Generic GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Associated Types

type Rep GetResourceShareInvitations :: Type -> Type #

Read GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Show GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

NFData GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Eq GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Hashable GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

type AWSResponse GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

type Rep GetResourceShareInvitations Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

type Rep GetResourceShareInvitations = D1 ('MetaData "GetResourceShareInvitations" "Amazonka.RAM.GetResourceShareInvitations" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "GetResourceShareInvitations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceShareArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "resourceShareInvitationArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newGetResourceShareInvitations :: GetResourceShareInvitations Source #

Create a value of GetResourceShareInvitations 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:maxResults:GetResourceShareInvitations', getResourceShareInvitations_maxResults - 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.

GetResourceShareInvitations, getResourceShareInvitations_nextToken - 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.

$sel:resourceShareArns:GetResourceShareInvitations', getResourceShareInvitations_resourceShareArns - Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

$sel:resourceShareInvitationArns:GetResourceShareInvitations', getResourceShareInvitations_resourceShareInvitationArns - Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

Request Lenses

getResourceShareInvitations_maxResults :: Lens' GetResourceShareInvitations (Maybe Natural) Source #

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.

getResourceShareInvitations_nextToken :: Lens' GetResourceShareInvitations (Maybe Text) Source #

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.

getResourceShareInvitations_resourceShareArns :: Lens' GetResourceShareInvitations (Maybe [Text]) Source #

Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

getResourceShareInvitations_resourceShareInvitationArns :: Lens' GetResourceShareInvitations (Maybe [Text]) Source #

Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

Destructuring the Response

data GetResourceShareInvitationsResponse Source #

Constructors

GetResourceShareInvitationsResponse' 

Fields

  • nextToken :: Maybe Text

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

  • resourceShareInvitations :: Maybe [ResourceShareInvitation]

    An array of objects that contain the details about the invitations.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetResourceShareInvitationsResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Read GetResourceShareInvitationsResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Show GetResourceShareInvitationsResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

NFData GetResourceShareInvitationsResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

Eq GetResourceShareInvitationsResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

type Rep GetResourceShareInvitationsResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourceShareInvitations

type Rep GetResourceShareInvitationsResponse = D1 ('MetaData "GetResourceShareInvitationsResponse" "Amazonka.RAM.GetResourceShareInvitations" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "GetResourceShareInvitationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceShareInvitations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceShareInvitation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourceShareInvitationsResponse Source #

Create a value of GetResourceShareInvitationsResponse 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:

GetResourceShareInvitations, getResourceShareInvitationsResponse_nextToken - If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

$sel:resourceShareInvitations:GetResourceShareInvitationsResponse', getResourceShareInvitationsResponse_resourceShareInvitations - An array of objects that contain the details about the invitations.

$sel:httpStatus:GetResourceShareInvitationsResponse', getResourceShareInvitationsResponse_httpStatus - The response's http status code.

Response Lenses

getResourceShareInvitationsResponse_nextToken :: Lens' GetResourceShareInvitationsResponse (Maybe Text) Source #

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.