describe_aggregate_id_format¶
Operation¶
describe_aggregate_id_format
¶
describe_aggregate_id_format(request: DescribeAggregateIdFormatInput | DescribeAggregateIdFormatInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAggregateIdFormatInputDict]) -> DescribeAggregateIdFormatOutput
Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle |
conversion-task | customer-gateway | dhcp-options |
elastic-ip-allocation | elastic-ip-association | export-task |
flow-log | image | import-task | instance |
internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list
| reservation | route-table | route-table-association |
security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeAggregateIdFormatInput | DescribeAggregateIdFormatInputDict | 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[DescribeAggregateIdFormatInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeAggregateIdFormatOutput
|
An instance of |
describe_aggregate_id_format
async
¶
describe_aggregate_id_format(request: DescribeAggregateIdFormatInput | DescribeAggregateIdFormatInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAggregateIdFormatInputDict]) -> DescribeAggregateIdFormatOutput
Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle |
conversion-task | customer-gateway | dhcp-options |
elastic-ip-allocation | elastic-ip-association | export-task |
flow-log | image | import-task | instance |
internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list
| reservation | route-table | route-table-association |
security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeAggregateIdFormatInput | DescribeAggregateIdFormatInputDict | 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[DescribeAggregateIdFormatInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeAggregateIdFormatOutput
|
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.
DescribeAggregateIdFormatInputDict
¶
Bases: TypedDict
Dictionary form of DescribeAggregateIdFormatInput.
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.
DescribeAggregateIdFormatInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeAggregateIdFormatInput 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.
Output¶
DescribeAggregateIdFormatOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeAggregateIdFormatOutput structure.
Attributes¶
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.
statuses
class-attribute
instance-attribute
¶
Information about each resource's ID format.