update_identity_store `async` ¶

update_identity_store(
    identity_store_id: IdentityStoreId,
    *,
    config_overrides: Optional[AsyncidentitystoreClientConfig] = None,
    network_configuration: Optional[NetworkConfiguration] = None,
) -> UpdateIdentityStoreResponse

Updates the configuration of the specified identity store, including its network configuration.

Parameters:

identity_store_id (IdentityStoreId) –

The globally unique identifier for the identity store.

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
network_configuration (Optional[NetworkConfiguration], default: None ) –

The network configuration to apply to the identity store. This controls whether access through a virtual private cloud (VPC) endpoint is required and the source VPCs and IP addresses that are allowed to access the identity store.

When you provide NetworkConfiguration in a request, the service performs a full replacement of the identity store's current network configuration with the values you specify. Any values that you omit are cleared. To preserve or change the allowed source VPCs or IP address ranges, include the complete set of values that you want in the request. To clear a list, omit it; an empty list is not accepted.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure with an internal server.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ConflictException –
This request cannot be completed for one of the following reasons:
- Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
- The requested resource was being concurrently modified by another request.
ResourceNotFoundException –

Indicates that a requested resource is not found.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_identitystore/_services/async_identitystore.py

async def update_identity_store(
    self,
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
    *,
    config_overrides: Optional[AsyncidentitystoreClientConfig] = None,
    network_configuration: Optional[
        "capo_identitystore.types.network_configuration.NetworkConfiguration"
    ] = None,
) -> "capo_identitystore.types.update_identity_store_response.UpdateIdentityStoreResponse":
    """<p>Updates the configuration of the specified identity store, including its network configuration.</p>

    Args:
        identity_store_id: <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
        network_configuration: <p>The network configuration to apply to the identity store. This controls whether access through a virtual private cloud (VPC) endpoint is required and the source VPCs and IP addresses that are allowed to access the identity store.</p> <p>When you provide <code>NetworkConfiguration</code> in a request, the service performs a full replacement of the identity store's current network configuration with the values you specify. Any values that you omit are cleared. To preserve or change the allowed source VPCs or IP address ranges, include the complete set of values that you want in the request. To clear a list, omit it; an empty list is not accepted.</p>

    Raises:
        capo_identitystore.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_identitystore.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
        capo_identitystore.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_identitystore.errors.conflict_exception.ConflictException: <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
        capo_identitystore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_identitystore.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_identitystore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_identitystore.types.update_identity_store_request.UpdateIdentityStoreRequest]",
    ) -> AsyncOperationResponse[
        "capo_identitystore.types.update_identity_store_response.UpdateIdentityStoreResponse"
    ]:
        import capo_identitystore._operations.aws_identity_store.update_identity_store

        (
            output,
            http_response,
        ) = await capo_identitystore._operations.aws_identity_store.update_identity_store.async_update_identity_store(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateIdentityStore")
    )
    input_: capo_identitystore.types.update_identity_store_request.UpdateIdentityStoreRequest = {
        "identity_store_id": identity_store_id
    }
    if network_configuration is not None:
        input_["network_configuration"] = network_configuration

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_identity_store async ¶

update_identity_store `async` ¶