EC2 / Client / describe_ipam_resource_discoveries

describe_ipam_resource_discoveries#

EC2.Client.describe_ipam_resource_discoveries(**kwargs)#

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Request Syntax

response = client.describe_ipam_resource_discoveries(
    DryRun=True|False,
    IpamResourceDiscoveryIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

DryRun (boolean) – 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.
IpamResourceDiscoveryIds (list) –
The IPAM resource discovery IDs.
- (string) –
NextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults (integer) – The maximum number of resource discoveries to return in one page of results.
Filters (list) –
The resource discovery filters.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IpamResourceDiscoveries': [
        {
            'OwnerId': 'string',
            'IpamResourceDiscoveryId': 'string',
            'IpamResourceDiscoveryArn': 'string',
            'IpamResourceDiscoveryRegion': 'string',
            'Description': 'string',
            'OperatingRegions': [
                {
                    'RegionName': 'string'
                },
            ],
            'IsDefault': True|False,
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'OrganizationalUnitExclusions': [
                {
                    'OrganizationsEntityPath': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- IpamResourceDiscoveries (list) –
  
  The resource discoveries.
  - (dict) –
    
    A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
    - OwnerId (string) –
      
      The ID of the owner.
    - IpamResourceDiscoveryId (string) –
      
      The resource discovery ID.
    - IpamResourceDiscoveryArn (string) –
      
      The resource discovery Amazon Resource Name (ARN).
    - IpamResourceDiscoveryRegion (string) –
      
      The resource discovery Region.
    - Description (string) –
      
      The resource discovery description.
    - OperatingRegions (list) –
      
      The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
      - (dict) –
        
        The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
        
        For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
        
        RegionName (string) –
        
        The name of the operating Region.
    - IsDefault (boolean) –
      
      Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
    - State (string) –
      
      The lifecycle state of the resource discovery.
      - create-in-progress - Resource discovery is being created.
      - create-complete - Resource discovery creation is complete.
      - create-failed - Resource discovery creation has failed.
      - modify-in-progress - Resource discovery is being modified.
      - modify-complete - Resource discovery modification is complete.
      - modify-failed - Resource discovery modification has failed.
      - delete-in-progress - Resource discovery is being deleted.
      - delete-complete - Resource discovery deletion is complete.
      - delete-failed - Resource discovery deletion has failed.
      - isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.
      - isolate-complete - Resource discovery isolation is complete.
      - restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.
    - Tags (list) –
      
      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - OrganizationalUnitExclusions (list) –
      
      If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
      - (dict) –
        
        If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
        
        OrganizationsEntityPath (string) –
        
        An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.
- NextToken (string) –
  
  Specify the pagination token from a previous request to retrieve the next page of results.