Skip to content

update_application async

update_application(
    arn: ArnOrUUID,
    *,
    config_overrides: Optional[AsyncAppIntegrationsClientConfig] = None,
    name: Optional[ApplicationName] = None,
    description: Optional[Description] = None,
    application_source_config: Optional[ApplicationSourceConfig] = None,
    subscriptions: Optional[SubscriptionList] = None,
    publications: Optional[PublicationList] = None,
    permissions: Optional[PermissionList] = None,
    is_service: Optional[Boolean] = None,
    initialization_timeout: Optional[InitializationTimeout] = None,
    application_config: Optional[ApplicationConfig] = None,
    iframe_config: Optional[IframeConfig] = None,
    application_type: Optional[ApplicationType] = None,
    auth_config: Optional[AuthConfig] = None,
) -> UpdateApplicationResponse

Updates and persists an Application resource.

Parameters:

  • arn (ArnOrUUID) –

    The Amazon Resource Name (ARN) of the Application.

  • name (Optional[ApplicationName], default: None ) –

    The name of the application.

  • description (Optional[Description], default: None ) –

    The description of the application.

  • application_source_config (Optional[ApplicationSourceConfig], default: None ) –

    The configuration for where the application should be loaded from.

  • subscriptions (Optional[SubscriptionList], default: None ) –

    The events that the application subscribes.

  • publications (Optional[PublicationList], default: None ) –

    The events that the application publishes.

  • permissions (Optional[PermissionList], default: None ) –

    The configuration of events or requests that the application has access to.

  • is_service (Optional[Boolean], default: None ) –

    Indicates whether the application is a service.

  • initialization_timeout (Optional[InitializationTimeout], default: None ) –

    The maximum time in milliseconds allowed to establish a connection with the workspace.

  • application_config (Optional[ApplicationConfig], default: None ) –

    The configuration settings for the application.

  • iframe_config (Optional[IframeConfig], default: None ) –

    The iframe configuration for the application.

  • application_type (Optional[ApplicationType], default: None ) –

    The type of application.

  • auth_config (Optional[AuthConfig], default: None ) –

    The authentication settings that Connect Customer uses when calling the external application.

Raises:

Examples:

To update an application The following updates an existing application named with a new name.

>>> await client.update_application(arn='arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e', name='My New Application Name')
Source code in docs_src/capo_appintegrations/_services/async_app_integrations.py
async def update_application(
    self,
    arn: "capo_appintegrations.types.arn_or_uuid.ArnOrUUID",
    *,
    config_overrides: Optional[AsyncAppIntegrationsClientConfig] = None,
    name: Optional[
        "capo_appintegrations.types.application_name.ApplicationName"
    ] = None,
    description: Optional[
        "capo_appintegrations.types.description.Description"
    ] = None,
    application_source_config: Optional[
        "capo_appintegrations.types.application_source_config.ApplicationSourceConfig"
    ] = None,
    subscriptions: Optional[
        "capo_appintegrations.types.subscription_list.SubscriptionList"
    ] = None,
    publications: Optional[
        "capo_appintegrations.types.publication_list.PublicationList"
    ] = None,
    permissions: Optional[
        "capo_appintegrations.types.permission_list.PermissionList"
    ] = None,
    is_service: Optional["capo_appintegrations.types.boolean.Boolean"] = None,
    initialization_timeout: Optional[
        "capo_appintegrations.types.initialization_timeout.InitializationTimeout"
    ] = None,
    application_config: Optional[
        "capo_appintegrations.types.application_config.ApplicationConfig"
    ] = None,
    iframe_config: Optional[
        "capo_appintegrations.types.iframe_config.IframeConfig"
    ] = None,
    application_type: Optional[
        "capo_appintegrations.types.application_type.ApplicationType"
    ] = None,
    auth_config: Optional[
        "capo_appintegrations.types.auth_config.AuthConfig"
    ] = None,
) -> "capo_appintegrations.types.update_application_response.UpdateApplicationResponse":
    """<p>Updates and persists an Application resource.</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the Application.</p>
        name: <p>The name of the application.</p>
        description: <p>The description of the application.</p>
        application_source_config: <p>The configuration for where the application should be loaded from.</p>
        subscriptions: <p>The events that the application subscribes.</p>
        publications: <p>The events that the application publishes.</p>
        permissions: <p>The configuration of events or requests that the application has access to.</p>
        is_service: <p>Indicates whether the application is a service.</p>
        initialization_timeout: <p>The maximum time in milliseconds allowed to establish a connection with the workspace.</p>
        application_config: <p>The configuration settings for the application.</p>
        iframe_config: <p>The iframe configuration for the application.</p>
        application_type: <p>The type of application.</p>
        auth_config: <p>The authentication settings that Connect Customer uses when calling the external application.</p>

    Raises:
        capo_appintegrations.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_appintegrations.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. Verify the application's current state and retry the request.</p>
        capo_appintegrations.errors.internal_service_error.InternalServiceError: <p>Request processing failed due to an error or failure with the service.</p>
        capo_appintegrations.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid. </p>
        capo_appintegrations.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appintegrations.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_appintegrations.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_appintegrations.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update an application
        The following updates an existing application named with a new name.

        >>> await client.update_application(arn='arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e', name='My New Application Name')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appintegrations.types.update_application_request.UpdateApplicationRequest]",
    ) -> AsyncOperationResponse[
        "capo_appintegrations.types.update_application_response.UpdateApplicationResponse"
    ]:
        import capo_appintegrations._operations.amazon_app_integration_service.update_application

        (
            output,
            http_response,
        ) = await capo_appintegrations._operations.amazon_app_integration_service.update_application.async_update_application(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateApplication")
    )
    input_: capo_appintegrations.types.update_application_request.UpdateApplicationRequest = {
        "arn": arn
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if application_source_config is not None:
        input_["application_source_config"] = application_source_config
    if subscriptions is not None:
        input_["subscriptions"] = subscriptions
    if publications is not None:
        input_["publications"] = publications
    if permissions is not None:
        input_["permissions"] = permissions
    if is_service is not None:
        input_["is_service"] = is_service
    if initialization_timeout is not None:
        input_["initialization_timeout"] = initialization_timeout
    if application_config is not None:
        input_["application_config"] = application_config
    if iframe_config is not None:
        input_["iframe_config"] = iframe_config
    if application_type is not None:
        input_["application_type"] = application_type
    if auth_config is not None:
        input_["auth_config"] = auth_config

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