GetManagedPrefixListAssociationsCommand

Suggest an Edit

Gets information about the resources that are associated with the specified managed prefix list.

Example Syntax

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

import { EC2Client, GetManagedPrefixListAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, GetManagedPrefixListAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // GetManagedPrefixListAssociationsRequest
  DryRun: true || false,
  PrefixListId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new GetManagedPrefixListAssociationsCommand(input);
const response = await client.send(command);
// { // GetManagedPrefixListAssociationsResult
//   PrefixListAssociations: [ // PrefixListAssociationSet
//     { // PrefixListAssociation
//       ResourceId: "STRING_VALUE",
//       ResourceOwner: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

GetManagedPrefixListAssociationsCommand Input

See GetManagedPrefixListAssociationsCommandInput for more details

Parameter
Type
Description
PrefixListId
Required
string | undefined

The ID of the prefix list.

DryRun
boolean | undefined

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

MaxResults
number | undefined

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

NextToken
string | undefined

The token for the next page of results.

GetManagedPrefixListAssociationsCommand Output

See GetManagedPrefixListAssociationsCommandOutput for details

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

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

PrefixListAssociations
PrefixListAssociation[] | undefined

Information about the associations.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.