GetResourceShareAssociationsCommand

Suggest an Edit

Retrieves the lists of resources and principals that associated for resource shares that you own.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RAMClient, GetResourceShareAssociationsCommand } from "@aws-sdk/client-ram"; // ES Modules import
// const { RAMClient, GetResourceShareAssociationsCommand } = require("@aws-sdk/client-ram"); // CommonJS import
const client = new RAMClient(config);
const input = { // GetResourceShareAssociationsRequest
  associationType: "PRINCIPAL" || "RESOURCE", // required
  resourceShareArns: [ // ResourceShareArnList
    "STRING_VALUE",
  ],
  resourceArn: "STRING_VALUE",
  principal: "STRING_VALUE",
  associationStatus: "ASSOCIATING" || "ASSOCIATED" || "FAILED" || "DISASSOCIATING" || "DISASSOCIATED",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new GetResourceShareAssociationsCommand(input);
const response = await client.send(command);
// { // GetResourceShareAssociationsResponse
//   resourceShareAssociations: [ // ResourceShareAssociationList
//     { // ResourceShareAssociation
//       resourceShareArn: "STRING_VALUE",
//       resourceShareName: "STRING_VALUE",
//       associatedEntity: "STRING_VALUE",
//       associationType: "PRINCIPAL" || "RESOURCE",
//       status: "ASSOCIATING" || "ASSOCIATED" || "FAILED" || "DISASSOCIATING" || "DISASSOCIATED",
//       statusMessage: "STRING_VALUE",
//       creationTime: new Date("TIMESTAMP"),
//       lastUpdatedTime: new Date("TIMESTAMP"),
//       external: true || false,
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

GetResourceShareAssociationsCommand Input

See GetResourceShareAssociationsCommandInput for more details

Parameter
Type
Description
associationType
Required
ResourceShareAssociationType | undefined

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.

associationStatus
ResourceShareAssociationStatus | undefined

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

maxResults
number | undefined

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
string | undefined

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
string | undefined

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.

resourceArn
string | undefined

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.

resourceShareArns
string[] | undefined

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

GetResourceShareAssociationsCommand Output

See GetResourceShareAssociationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
nextToken
string | undefined

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
ResourceShareAssociation[] | undefined

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

Throws

Name
Fault
Details
InvalidNextTokenException
client

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException
client

The operation failed because a parameter you specified isn't valid.

MalformedArnException
client

The operation failed because the specified Amazon Resource Name (ARN)  has a format that isn't valid.

OperationNotPermittedException
client

The operation failed because the requested operation isn't permitted.

ServerInternalException
server

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException
server

The operation failed because the service isn't available. Try again later.

UnknownResourceException
client

The operation failed because a specified resource couldn't be found.

RAMServiceException
Base exception class for all service exceptions from RAM service.