get_ipam_discovered_accounts¶
Operation¶
get_ipam_discovered_accounts
¶
get_ipam_discovered_accounts(request: GetIpamDiscoveredAccountsInput | GetIpamDiscoveredAccountsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredAccountsInputDict]) -> GetIpamDiscoveredAccountsOutput
Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIpamDiscoveredAccountsInput | GetIpamDiscoveredAccountsInputDict | 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[GetIpamDiscoveredAccountsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIpamDiscoveredAccountsOutput
|
An instance of |
get_ipam_discovered_accounts
async
¶
get_ipam_discovered_accounts(request: GetIpamDiscoveredAccountsInput | GetIpamDiscoveredAccountsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredAccountsInputDict]) -> GetIpamDiscoveredAccountsOutput
Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIpamDiscoveredAccountsInput | GetIpamDiscoveredAccountsInputDict | 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[GetIpamDiscoveredAccountsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIpamDiscoveredAccountsOutput
|
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.
GetIpamDiscoveredAccountsInputDict
¶
Bases: TypedDict
Dictionary form of GetIpamDiscoveredAccountsInput.
Attributes¶
discovery_region
instance-attribute
¶
The Amazon Web Services Region that the account information is returned from.
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
Discovered account filters.
ipam_resource_discovery_id
instance-attribute
¶
A resource discovery ID.
GetIpamDiscoveredAccountsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamDiscoveredAccountsInput structure.
Attributes¶
discovery_region
class-attribute
instance-attribute
¶
discovery_region: str | None = ...
The Amazon Web Services Region that the account information is returned from.
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.
filters
class-attribute
instance-attribute
¶
Discovered account filters.
ipam_resource_discovery_id
class-attribute
instance-attribute
¶
ipam_resource_discovery_id: str | None = ...
A resource discovery ID.
Output¶
GetIpamDiscoveredAccountsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamDiscoveredAccountsOutput structure.
Attributes¶
ipam_discovered_accounts
class-attribute
instance-attribute
¶
ipam_discovered_accounts: list[IpamDiscoveredAccount] | None = ...
Discovered accounts.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
Specify the pagination token from a previous request to retrieve the next page of results.
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.