Amazonka.RAM.GetResourceShareAssociations

Retrieves the resource and principal associations for resource shares that you own.

This operation returns paginated results.

Creating a Request

data GetResourceShareAssociations

See: newGetResourceShareAssociations smart constructor.

Constructors

GetResourceShareAssociations'

Fields

• associationStatus :: Maybe ResourceShareAssociationStatus

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

• 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.

• principal :: Maybe Text

  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.

• resourceArn :: Maybe Text

  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.

• resourceShareArns :: Maybe [Text]

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

• associationType :: ResourceShareAssociationType

  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.

Instances

ToJSON GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

toJSON :: GetResourceShareAssociations -> Value

toEncoding :: GetResourceShareAssociations -> Encoding

toJSONList :: [GetResourceShareAssociations] -> Value

toEncodingList :: [GetResourceShareAssociations] -> Encoding

ToHeaders GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

toHeaders :: GetResourceShareAssociations -> [Header]

ToPath GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

toPath :: GetResourceShareAssociations -> ByteString

ToQuery GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

toQuery :: GetResourceShareAssociations -> QueryString

AWSPager GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

page :: GetResourceShareAssociations -> AWSResponse GetResourceShareAssociations -> Maybe GetResourceShareAssociations

AWSRequest GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Associated Types

type AWSResponse GetResourceShareAssociations

Methods

request :: (Service -> Service) -> GetResourceShareAssociations -> Request GetResourceShareAssociations

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetResourceShareAssociations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResourceShareAssociations)))

Generic GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Associated Types

type Rep GetResourceShareAssociations :: Type -> Type

Methods

from :: GetResourceShareAssociations -> Rep GetResourceShareAssociations x

to :: Rep GetResourceShareAssociations x -> GetResourceShareAssociations

Read GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

readsPrec :: Int -> ReadS GetResourceShareAssociations

readList :: ReadS [GetResourceShareAssociations]

readPrec :: ReadPrec GetResourceShareAssociations

readListPrec :: ReadPrec [GetResourceShareAssociations]

Show GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

showsPrec :: Int -> GetResourceShareAssociations -> ShowS

show :: GetResourceShareAssociations -> String

showList :: [GetResourceShareAssociations] -> ShowS

NFData GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

rnf :: GetResourceShareAssociations -> ()

Eq GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

(==) :: GetResourceShareAssociations -> GetResourceShareAssociations -> Bool

(/=) :: GetResourceShareAssociations -> GetResourceShareAssociations -> Bool

Hashable GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

hashWithSalt :: Int -> GetResourceShareAssociations -> Int

hash :: GetResourceShareAssociations -> Int

type AWSResponse GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

type AWSResponse GetResourceShareAssociations = GetResourceShareAssociationsResponse

type Rep GetResourceShareAssociations

Defined in Amazonka.RAM.GetResourceShareAssociations

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

newGetResourceShareAssociations

Arguments

:: ResourceShareAssociationType

GetResourceShareAssociations

-> GetResourceShareAssociations

Create a value of GetResourceShareAssociations 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:associationStatus:GetResourceShareAssociations', getResourceShareAssociations_associationStatus - Specifies that you want to retrieve only associations with this status.

$sel:maxResults:GetResourceShareAssociations', getResourceShareAssociations_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.

GetResourceShareAssociations, getResourceShareAssociations_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:principal:GetResourceShareAssociations', getResourceShareAssociations_principal - 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.

$sel:resourceArn:GetResourceShareAssociations', getResourceShareAssociations_resourceArn - 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.

$sel:resourceShareArns:GetResourceShareAssociations', getResourceShareAssociations_resourceShareArns - Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

GetResourceShareAssociations, getResourceShareAssociations_associationType - 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.

Request Lenses

getResourceShareAssociations_associationStatus :: Lens' GetResourceShareAssociations (Maybe ResourceShareAssociationStatus)

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

getResourceShareAssociations_maxResults :: Lens' GetResourceShareAssociations (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.

getResourceShareAssociations_nextToken :: Lens' GetResourceShareAssociations (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.

getResourceShareAssociations_principal :: Lens' GetResourceShareAssociations (Maybe Text)

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.

getResourceShareAssociations_resourceArn :: Lens' GetResourceShareAssociations (Maybe Text)

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.

getResourceShareAssociations_resourceShareArns :: Lens' GetResourceShareAssociations (Maybe [Text])

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

getResourceShareAssociations_associationType :: Lens' GetResourceShareAssociations ResourceShareAssociationType

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.

Destructuring the Response

data GetResourceShareAssociationsResponse

See: newGetResourceShareAssociationsResponse smart constructor.

Constructors

GetResourceShareAssociationsResponse'

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.

• resourceShareAssociations :: Maybe [ResourceShareAssociation]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetResourceShareAssociationsResponse

Defined in Amazonka.RAM.GetResourceShareAssociations

Associated Types

type Rep GetResourceShareAssociationsResponse :: Type -> Type

Methods

from :: GetResourceShareAssociationsResponse -> Rep GetResourceShareAssociationsResponse x

to :: Rep GetResourceShareAssociationsResponse x -> GetResourceShareAssociationsResponse

Read GetResourceShareAssociationsResponse

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

readsPrec :: Int -> ReadS GetResourceShareAssociationsResponse

readList :: ReadS [GetResourceShareAssociationsResponse]

readPrec :: ReadPrec GetResourceShareAssociationsResponse

readListPrec :: ReadPrec [GetResourceShareAssociationsResponse]

Show GetResourceShareAssociationsResponse

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

showsPrec :: Int -> GetResourceShareAssociationsResponse -> ShowS

show :: GetResourceShareAssociationsResponse -> String

showList :: [GetResourceShareAssociationsResponse] -> ShowS

NFData GetResourceShareAssociationsResponse

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

rnf :: GetResourceShareAssociationsResponse -> ()

Eq GetResourceShareAssociationsResponse

Defined in Amazonka.RAM.GetResourceShareAssociations

Methods

(==) :: GetResourceShareAssociationsResponse -> GetResourceShareAssociationsResponse -> Bool

(/=) :: GetResourceShareAssociationsResponse -> GetResourceShareAssociationsResponse -> Bool

type Rep GetResourceShareAssociationsResponse

Defined in Amazonka.RAM.GetResourceShareAssociations

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

newGetResourceShareAssociationsResponse

Arguments

:: Int

$sel:httpStatus:GetResourceShareAssociationsResponse'

-> GetResourceShareAssociationsResponse

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

GetResourceShareAssociations, getResourceShareAssociationsResponse_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.

GetResourceShareAssociationsResponse, getResourceShareAssociationsResponse_resourceShareAssociations - An array of objects that contain the details about the associations.

$sel:httpStatus:GetResourceShareAssociationsResponse', getResourceShareAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

getResourceShareAssociationsResponse_nextToken :: Lens' GetResourceShareAssociationsResponse (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.

getResourceShareAssociationsResponse_resourceShareAssociations :: Lens' GetResourceShareAssociationsResponse (Maybe [ResourceShareAssociation])

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

getResourceShareAssociationsResponse_httpStatus :: Lens' GetResourceShareAssociationsResponse Int

The response's http status code.