put_app_instance_user_expiration_settings ¶

put_app_instance_user_expiration_settings(
    app_instance_user_arn: ChimeArn,
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
    expiration_settings: Optional[ExpirationSettings] = None,
) -> PutAppInstanceUserExpirationSettingsResponse

Sets the number of days before the AppInstanceUser is automatically deleted.

A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary.

Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

Parameters:

app_instance_user_arn (ChimeArn) –

The ARN of the AppInstanceUser.
expiration_settings (Optional[ExpirationSettings], default: None ) –

Settings that control the interval after which an AppInstanceUser is automatically deleted.

Raises:

BadRequestException –

The input parameters don't match the service's restrictions.
ConflictException –

The request could not be processed because of conflict in the current state of the resource.
ForbiddenException –

The client is permanently forbidden from making the request.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The client exceeded its request rate limit.
UnauthorizedClientException –

The client is not currently authorized to make the request.
UnknownServiceError –

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

Source code in docs_src/capo_chime_sdk_identity/_services/chime_sdk_identity.py

def put_app_instance_user_expiration_settings(
    self,
    app_instance_user_arn: "capo_chime_sdk_identity.types.chime_arn.ChimeArn",
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
    expiration_settings: Optional[
        "capo_chime_sdk_identity.types.expiration_settings.ExpirationSettings"
    ] = None,
) -> "capo_chime_sdk_identity.types.put_app_instance_user_expiration_settings_response.PutAppInstanceUserExpirationSettingsResponse":
    """<p>Sets the number of days before the <code>AppInstanceUser</code> is automatically deleted.</p> <note> <p>A background process deletes expired <code>AppInstanceUsers</code> within 6 hours of expiration. Actual deletion times may vary.</p> <p>Expired <code>AppInstanceUsers</code> that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.</p> </note>

    Args:
        app_instance_user_arn: <p>The ARN of the <code>AppInstanceUser</code>.</p>
        expiration_settings: <p>Settings that control the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>

    Raises:
        capo_chime_sdk_identity.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_identity.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime_sdk_identity.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_identity.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_identity.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_identity.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_identity.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_identity.types.put_app_instance_user_expiration_settings_request.PutAppInstanceUserExpirationSettingsRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_identity.types.put_app_instance_user_expiration_settings_response.PutAppInstanceUserExpirationSettingsResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.put_app_instance_user_expiration_settings

        output, http_response = (
            capo_chime_sdk_identity._operations.chime_identity_service.put_app_instance_user_expiration_settings.put_app_instance_user_expiration_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutAppInstanceUserExpirationSettings")
    )
    input_: capo_chime_sdk_identity.types.put_app_instance_user_expiration_settings_request.PutAppInstanceUserExpirationSettingsRequest = {
        "app_instance_user_arn": app_instance_user_arn
    }
    if expiration_settings is not None:
        input_["expiration_settings"] = expiration_settings

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output