Updates a requester gateway.
Parameters:
-
client_token
(str)
–
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
-
gateway_id
(GatewayId)
–
The unique identifier of the gateway.
-
description
(Optional[str], default:
None
)
–
An optional description for the requester gateway.
Raises:
-
AccessDeniedException
–
The request could not be completed because you do not have sufficient access to perform this action.
-
ConflictException
–
The request could not be completed because of a conflict in the current state of the resource.
-
InternalServerException
–
The request could not be completed because of an internal server error. Try your call again.
-
ResourceNotFoundException
–
The request could not be completed because the resource does not exist.
-
ThrottlingException
–
The request was denied due to request throttling.
-
ValidationException
–
The request could not be completed because it fails satisfy the constraints specified by the service.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
Update requester gateway
Update requester gateway
>>> client.update_requester_gateway(gateway_id='rtb-gw-12345678', description='Updated requester gateway description', client_token='12345678-1234-1234-1234-123456789012')
Source code in docs_src/capo_rtbfabric/_services/rtb_fabric.py
| def update_requester_gateway(
self,
client_token: str,
gateway_id: "capo_rtbfabric.types.gateway_id.GatewayId",
*,
config_overrides: Optional[RTBFabricClientConfig] = None,
description: Optional[str] = None,
) -> "capo_rtbfabric.types.update_requester_gateway_response.UpdateRequesterGatewayResponse":
"""<p>Updates a requester gateway.</p>
Args:
client_token: <p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>clientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>
gateway_id: <p>The unique identifier of the gateway.</p>
description: <p>An optional description for the requester gateway.</p>
Raises:
capo_rtbfabric.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
capo_rtbfabric.errors.conflict_exception.ConflictException: <p>The request could not be completed because of a conflict in the current state of the resource.</p>
capo_rtbfabric.errors.internal_server_exception.InternalServerException: <p>The request could not be completed because of an internal server error. Try your call again.</p>
capo_rtbfabric.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request could not be completed because the resource does not exist.</p>
capo_rtbfabric.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_rtbfabric.errors.validation_exception.ValidationException: <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
capo_rtbfabric.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
Update requester gateway
Update requester gateway
>>> client.update_requester_gateway(gateway_id='rtb-gw-12345678', description='Updated requester gateway description', client_token='12345678-1234-1234-1234-123456789012')
"""
def _handler(
req: "OperationRequest[capo_rtbfabric.types.update_requester_gateway_request.UpdateRequesterGatewayRequest]",
) -> OperationResponse[
"capo_rtbfabric.types.update_requester_gateway_response.UpdateRequesterGatewayResponse"
]:
import capo_rtbfabric._operations.rtb_fabric.update_requester_gateway
output, http_response = (
capo_rtbfabric._operations.rtb_fabric.update_requester_gateway.update_requester_gateway(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("UpdateRequesterGateway")
)
input_: capo_rtbfabric.types.update_requester_gateway_request.UpdateRequesterGatewayRequest = {
"client_token": client_token,
"gateway_id": gateway_id,
}
if description is not None:
input_["description"] = description
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|