EC2 / Client / describe_ipam_resource_discovery_associations

describe_ipam_resource_discovery_associations#

EC2.Client.describe_ipam_resource_discovery_associations(**kwargs)#

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

See also: AWS API Documentation

Request Syntax

response = client.describe_ipam_resource_discovery_associations(
    DryRun=True|False,
    IpamResourceDiscoveryAssociationIds=[
        '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.
IpamResourceDiscoveryAssociationIds (list) –
The resource discovery association 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 discovery associations to return in one page of results.
Filters (list) –
The resource discovery association 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

{
    'IpamResourceDiscoveryAssociations': [
        {
            'OwnerId': 'string',
            'IpamResourceDiscoveryAssociationId': 'string',
            'IpamResourceDiscoveryAssociationArn': 'string',
            'IpamResourceDiscoveryId': 'string',
            'IpamId': 'string',
            'IpamArn': 'string',
            'IpamRegion': 'string',
            'IsDefault': True|False,
            'ResourceDiscoveryStatus': 'active'|'not-found',
            'State': 'associate-in-progress'|'associate-complete'|'associate-failed'|'disassociate-in-progress'|'disassociate-complete'|'disassociate-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- IpamResourceDiscoveryAssociations (list) –
  
  The resource discovery associations.
  - (dict) –
    
    An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.
    - OwnerId (string) –
      
      The Amazon Web Services account ID of the resource discovery owner.
    - IpamResourceDiscoveryAssociationId (string) –
      
      The resource discovery association ID.
    - IpamResourceDiscoveryAssociationArn (string) –
      
      The resource discovery association Amazon Resource Name (ARN).
    - IpamResourceDiscoveryId (string) –
      
      The resource discovery ID.
    - IpamId (string) –
      
      The IPAM ID.
    - IpamArn (string) –
      
      The IPAM ARN.
    - IpamRegion (string) –
      
      The IPAM home Region.
    - IsDefault (boolean) –
      
      Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it’s associated with your IPAM.
    - ResourceDiscoveryStatus (string) –
      
      The resource discovery status.
      - active - Connection or permissions required to read the results of the resource discovery are intact.
      - not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.
    - State (string) –
      
      The lifecycle state of the association when you associate or disassociate a resource discovery.
      - associate-in-progress - Resource discovery is being associated.
      - associate-complete - Resource discovery association is complete.
      - associate-failed - Resource discovery association has failed.
      - disassociate-in-progress - Resource discovery is being disassociated.
      - disassociate-complete - Resource discovery disassociation is complete.
      - ``disassociate-failed ``- Resource discovery disassociation has failed.
      - isolate-in-progress - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.
      - isolate-complete - Resource discovery isolation is complete..
      - restore-in-progress - Resource discovery is being 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.
- NextToken (string) –
  
  Specify the pagination token from a previous request to retrieve the next page of results.