update_application ¶

def update_application(
    self,
    application_arn: "capo_sso_admin.types.application_arn.ApplicationArn",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    name: Optional[
        "capo_sso_admin.types.application_name_type.ApplicationNameType"
    ] = None,
    description: Optional["capo_sso_admin.types.description.Description"] = None,
    status: Optional[
        "capo_sso_admin.types.application_status.ApplicationStatus"
    ] = None,
    portal_options: Optional[
        "capo_sso_admin.types.update_application_portal_options.UpdateApplicationPortalOptions"
    ] = None,
) -> "capo_sso_admin.types.update_application_response.UpdateApplicationResponse":
    """<p>Updates application properties. </p>

    Args:
        application_arn: <p>Specifies the ARN of the application. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
        name: <p>Specifies the updated name for the application.</p>
        description: <p>The description of the .</p>
        status: <p>Specifies whether the application is enabled or disabled.</p>
        portal_options: <p>A structure that describes the options for the portal associated with an application.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_sso_admin.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_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sso_admin.types.update_application_request.UpdateApplicationRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.update_application_response.UpdateApplicationResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.update_application

        output, http_response = (
            capo_sso_admin._operations.swb_external_service.update_application.update_application(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateApplication")
    )
    input_: capo_sso_admin.types.update_application_request.UpdateApplicationRequest = {
        "application_arn": application_arn
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if status is not None:
        input_["status"] = status
    if portal_options is not None:
        input_["portal_options"] = portal_options

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