delete_ipam_scope¶
Operation¶
delete_ipam_scope
¶
delete_ipam_scope(request: DeleteIpamScopeInput | DeleteIpamScopeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIpamScopeInputDict]) -> DeleteIpamScopeOutput
Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteIpamScopeInput | DeleteIpamScopeInputDict | 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[DeleteIpamScopeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteIpamScopeOutput
|
An instance of |
delete_ipam_scope
async
¶
delete_ipam_scope(request: DeleteIpamScopeInput | DeleteIpamScopeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIpamScopeInputDict]) -> DeleteIpamScopeOutput
Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteIpamScopeInput | DeleteIpamScopeInputDict | 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[DeleteIpamScopeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteIpamScopeOutput
|
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.
DeleteIpamScopeInputDict
¶
Bases: TypedDict
Dictionary form of DeleteIpamScopeInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
A check for 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.
DeleteIpamScopeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteIpamScopeInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
A check for 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¶
DeleteIpamScopeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteIpamScopeOutput structure.
Attributes¶
ipam_scope
class-attribute
instance-attribute
¶
ipam_scope: IpamScope | None = ...
Information about the results of the deletion.
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.