create_ipam_internet_registry_association¶
Operation¶
create_ipam_internet_registry_association
¶
create_ipam_internet_registry_association(request: CreateIpamInternetRegistryAssociationInput | CreateIpamInternetRegistryAssociationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateIpamInternetRegistryAssociationInputDict]) -> CreateIpamInternetRegistryAssociationOutput
Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateIpamInternetRegistryAssociationInput | CreateIpamInternetRegistryAssociationInputDict | 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[CreateIpamInternetRegistryAssociationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateIpamInternetRegistryAssociationOutput
|
An instance of |
create_ipam_internet_registry_association
async
¶
create_ipam_internet_registry_association(request: CreateIpamInternetRegistryAssociationInput | CreateIpamInternetRegistryAssociationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateIpamInternetRegistryAssociationInputDict]) -> CreateIpamInternetRegistryAssociationOutput
Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateIpamInternetRegistryAssociationInput | CreateIpamInternetRegistryAssociationInputDict | 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[CreateIpamInternetRegistryAssociationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateIpamInternetRegistryAssociationOutput
|
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.
CreateIpamInternetRegistryAssociationInputDict
¶
Bases: TypedDict
Dictionary form of CreateIpamInternetRegistryAssociationInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
description
instance-attribute
¶
description: str | None
A description for the internet registry association.
dry_run
instance-attribute
¶
dry_run: bool | None
Checks whether you have the required permissions for the operation,
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.
ipam_id
instance-attribute
¶
The ID of the IPAM to associate with the internet registry.
organization_handle
instance-attribute
¶
The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID).
rir
instance-attribute
¶
The internet registry to associate with. Possible values:
-
ripe- RIPE NCC (Europe, the Middle East, and Central Asia). -
apnic- APNIC (Asia Pacific). -
arin- ARIN (North America). -
lacnic- LACNIC (Latin America and the Caribbean). -
nicbr- NIC.br (Brazil).
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to assign to the internet registry association.
CreateIpamInternetRegistryAssociationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamInternetRegistryAssociationInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the internet registry association.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the operation,
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.
ipam_id
class-attribute
instance-attribute
¶
ipam_id: str | None = ...
The ID of the IPAM to associate with the internet registry.
organization_handle
class-attribute
instance-attribute
¶
organization_handle: str | None = ...
The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID).
rir
class-attribute
instance-attribute
¶
rir: str | None = ...
The internet registry to associate with. Possible values:
-
ripe- RIPE NCC (Europe, the Middle East, and Central Asia). -
apnic- APNIC (Asia Pacific). -
arin- ARIN (North America). -
lacnic- LACNIC (Latin America and the Caribbean). -
nicbr- NIC.br (Brazil).
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to assign to the internet registry association.
Output¶
CreateIpamInternetRegistryAssociationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamInternetRegistryAssociationOutput structure.
Attributes¶
ipam_internet_registry_association
class-attribute
instance-attribute
¶
ipam_internet_registry_association: IpamInternetRegistryAssociation | None = ...
Information about the internet registry association.
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.