describe_secondary_networks¶
Operation¶
describe_secondary_networks
¶
describe_secondary_networks(request: DescribeSecondaryNetworksInput | DescribeSecondaryNetworksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeSecondaryNetworksInputDict]) -> DescribeSecondaryNetworksOutput
Describes one or more secondary networks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeSecondaryNetworksInput | DescribeSecondaryNetworksInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeSecondaryNetworksInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeSecondaryNetworksOutput
|
An instance of |
describe_secondary_networks
async
¶
describe_secondary_networks(request: DescribeSecondaryNetworksInput | DescribeSecondaryNetworksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeSecondaryNetworksInputDict]) -> DescribeSecondaryNetworksOutput
Describes one or more secondary networks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeSecondaryNetworksInput | DescribeSecondaryNetworksInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeSecondaryNetworksInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeSecondaryNetworksOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeSecondaryNetworksInputDict
¶
Bases: TypedDict
Dictionary form of DescribeSecondaryNetworksInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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: Sequence[Filter | FilterDict] | None
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:<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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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).
DescribeSecondaryNetworksInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeSecondaryNetworksInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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
class-attribute
instance-attribute
¶
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:<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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
Output¶
DescribeSecondaryNetworksOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeSecondaryNetworksOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
secondary_networks
class-attribute
instance-attribute
¶
secondary_networks: list[SecondaryNetwork] | None = ...
Information about the secondary networks.