[ aws . network-firewall ]

list-resources-in-context-store

Description

Lists the resources that a context store records. The context store must be associated with a transit gateway that your firewall is attached to. You can filter the results by Region, resource type, or both.

When using a small page size, a single call might not return the full list. A response can contain fewer than MaxResults results, or none, and still include a NextToken . Keep making requests until the response does not include a NextToken .

See also: AWS API Documentation

list-resources-in-context-store is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ResourceContexts

Synopsis

  list-resources-in-context-store
--context-store-id <value>
[--filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--context-store-id (string) [required]

The unique identifier of the context store. To get the identifiers of the context stores that are associated with your firewalls, call ListContextStores .

--filters (structure)

Optional filters that limit the results to resources in a specific Region, of a specific resource type, or both. If you specify both filters, Network Firewall returns only the resources that match both.

Region -> (string)

The Amazon Web Services Region of the resources to return, for example us-east-1 .

Constraints:

  • pattern: ^[a-z]{2}(-[a-z]+)+-\d+$

ResourceType -> (string)

The type of resource to return. Each resource type corresponds to the ContextType that Network Firewall reports for the resource:

  • SecurityGroup - Security groups. Reported with the SegmentId context type.
  • VPC - VPCs. Reported with the ResourceId context type.
  • Subnet - Subnets. Reported with the Subnet context type.
  • TGWAttachment - Transit gateway attachments. Reported with the Attachment context type.

Possible values:

  • SecurityGroup
  • VPC
  • Subnet
  • TGWAttachment

Shorthand Syntax:

Region=string,ResourceType=string

JSON Syntax:

{
  "Region": "string",
  "ResourceType": "SecurityGroup"|"VPC"|"Subnet"|"TGWAttachment"
}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

ResourceContexts -> (list)

The resources that the context store records and that match your filters.

(structure)

A resource that a context store records, which ListResourcesInContextStore returns.

ContextType -> (string)

The kind of context that the context store records for the resource. Valid values:

  • ResourceId - A VPC.
  • SegmentId - A security group.
  • Subnet - A subnet.
  • Attachment - A transit gateway attachment.

Possible values:

  • ResourceId
  • SegmentId
  • Subnet
  • Attachment

Region -> (string)

The Amazon Web Services Region of the resource.

Constraints:

  • pattern: ^[a-z]{2}(-[a-z]+)+-\d+$

AvailabilityZone -> (string)

The Availability Zone of the resource. Present for subnets.

AttachmentType -> (string)

The type of the transit gateway attachment. Present for attachments.

PublicId -> (string) [required]

The identifier of the resource, for example vpc-1234567890abcdef0 , subnet-1234567890abcdef0 , sg-1234567890abcdef0 , or tgw-attach-1234567890abcdef0 .

NextToken -> (string)

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Constraints:

  • min: 1
  • max: 4096
  • pattern: [0-9A-Za-z:\/+=]+$