EC2 / Client / modify_ipam_resource_discovery

modify_ipam_resource_discovery#

EC2.Client.modify_ipam_resource_discovery(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.modify_ipam_resource_discovery(
    DryRun=True|False,
    IpamResourceDiscoveryId='string',
    Description='string',
    AddOperatingRegions=[
        {
            'RegionName': 'string'
        },
    ],
    RemoveOperatingRegions=[
        {
            'RegionName': 'string'
        },
    ],
    AddOrganizationalUnitExclusions=[
        {
            'OrganizationsEntityPath': 'string'
        },
    ],
    RemoveOrganizationalUnitExclusions=[
        {
            'OrganizationsEntityPath': '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.

  • IpamResourceDiscoveryId (string) –

    [REQUIRED]

    A resource discovery ID.

  • Description (string) – A resource discovery description.

  • AddOperatingRegions (list) –

    Add operating Regions to 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) –

      Add an operating Region to 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.

  • RemoveOperatingRegions (list) –

    Remove operating Regions.

    • (dict) –

      Remove an operating Region from 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 you want to remove.

  • AddOrganizationalUnitExclusions (list) –

    Add an Organizational Unit (OU) exclusion to your IPAM. 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. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

    • (dict) –

      Add an Organizational Unit (OU) exclusion to your IPAM. 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. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

      • OrganizationsEntityPath (string) –

        An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.

        • Example 1

          • Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/

          • In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID.

          • IPAM will not manage the IP addresses in accounts in the child OU.

        • Example 2

          • Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*

          • In this example, IPAM will not manage the IP addresses in accounts in the OU ( ou-ghi0-awsccccc) or in accounts in any OUs that are children of the OU.

        For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

  • RemoveOrganizationalUnitExclusions (list) –

    Remove an Organizational Unit (OU) exclusion to your IPAM. 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. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

    • (dict) –

      Remove an Organizational Unit (OU) exclusion to your IPAM. 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. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

      • OrganizationsEntityPath (string) –

        An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.

        • Example 1

          • Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/

          • In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID.

          • IPAM will not manage the IP addresses in accounts in the child OU.

        • Example 2

          • Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*

          • In this example, IPAM will not manage the IP addresses in accounts in the OU ( ou-ghi0-awsccccc) or in accounts in any OUs that are children of the OU.

        For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'IpamResourceDiscovery': {
        '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'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • IpamResourceDiscovery (dict) –

      A resource discovery.

      • 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.