Skip to content

DescribeSecondaryNetworksRequest

Source code in docs_src/capo_ec2/types/describe_secondary_networks_request.py
class DescribeSecondaryNetworksRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    filters: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<p>The filters. The following are the possible values:</p> <ul> <li> <p> <code>ipv4-cidr-block-association.association-id</code> - The association ID for an IPv4 CIDR block associated with the secondary network.</p> </li> <li> <p> <code>ipv4-cidr-block-association.cidr-block</code> - An IPv4 CIDR block associated with the secondary network.</p> </li> <li> <p> <code>ipv4-cidr-block-association.state</code> - The state of an IPv4 CIDR block associated with the secondary network.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the secondary network.</p> </li> <li> <p> <code>secondary-network-id</code> - The ID of the secondary network.</p> </li> <li> <p> <code>secondary-network-arn</code> - The ARN of the secondary network.</p> </li> <li> <p> <code>state</code> - The state of the secondary network (<code>create-in-progress</code> | <code>create-complete</code> | <code>create-failed</code> | <code>delete-in-progress</code> | <code>delete-complete</code> | <code>delete-failed</code>).</p> </li> <li> <p> <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> <li> <p> <code>type</code> - The type of the secondary network (<code>rdma</code>).</p> </li> </ul>"""
    max_results: NotRequired[
        "capo_ec2.types.describe_secondary_networks_max_results.DescribeSecondaryNetworksMaxResults"
    ]
    """<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"""
    next_token: NotRequired["capo_ec2.types.string.String"]
    """<p>The token for the next page of results.</p>"""
    secondary_network_ids: NotRequired[
        "capo_ec2.types.secondary_network_id_list.SecondaryNetworkIdList"
    ]
    """<p>The IDs of the secondary networks.</p>"""

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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.

filters instance-attribute

filters: NotRequired[FilterList]

The filters. The following are the possible values:

  • ipv4-cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the secondary network.

  • ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary network.

  • ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary network.

  • owner-id - The ID of the Amazon Web Services account that owns the secondary network.

  • secondary-network-id - The ID of the secondary network.

  • secondary-network-arn - The ARN of the secondary network.

  • state - The state of the secondary network (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).

  • tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • type - The type of the secondary network (rdma).

max_results instance-attribute

max_results: NotRequired[DescribeSecondaryNetworksMaxResults]

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

next_token instance-attribute

next_token: NotRequired[String]

The token for the next page of results.

secondary_network_ids instance-attribute

secondary_network_ids: NotRequired[SecondaryNetworkIdList]

The IDs of the secondary networks.