Create a verification token.
A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
Parameters:
-
dry_run
(Optional[Boolean], default:
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.
-
ipam_id
(Optional[IpamId], default:
None
)
–
The ID of the IPAM that will create the token.
-
tag_specifications
(Optional[TagSpecificationList], default:
None
)
–
-
client_token
(Optional[String], default:
None
)
–
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Raises:
Source code in docs_src/capo_ec2/_services/ec2.py
| def create_ipam_external_resource_verification_token(
self,
*,
config_overrides: Optional[EC2ClientConfig] = None,
dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
ipam_id: Optional["capo_ec2.types.ipam_id.IpamId"] = None,
tag_specifications: Optional[
"capo_ec2.types.tag_specification_list.TagSpecificationList"
] = None,
client_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.create_ipam_external_resource_verification_token_result.CreateIpamExternalResourceVerificationTokenResult":
"""<p>Create a verification token.</p> <p>A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP). </p>
Args:
dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
ipam_id: <p>The ID of the IPAM that will create the token.</p>
tag_specifications: <p>Token tags.</p>
client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p>
Raises:
capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ec2.types.create_ipam_external_resource_verification_token_request.CreateIpamExternalResourceVerificationTokenRequest]",
) -> OperationResponse[
"capo_ec2.types.create_ipam_external_resource_verification_token_result.CreateIpamExternalResourceVerificationTokenResult"
]:
import capo_ec2._operations.amazon_ec2.create_ipam_external_resource_verification_token
output, http_response = (
capo_ec2._operations.amazon_ec2.create_ipam_external_resource_verification_token.create_ipam_external_resource_verification_token(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("CreateIpamExternalResourceVerificationToken"),
)
input_: capo_ec2.types.create_ipam_external_resource_verification_token_request.CreateIpamExternalResourceVerificationTokenRequest = {}
if dry_run is not None:
input_["dry_run"] = dry_run
if ipam_id is not None:
input_["ipam_id"] = ipam_id
if tag_specifications is not None:
input_["tag_specifications"] = tag_specifications
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|