put_application_authentication_method ¶

put_application_authentication_method(
    application_arn: ApplicationArn,
    authentication_method_type: AuthenticationMethodType,
    authentication_method: AuthenticationMethod,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> None

Adds or updates an authentication method for an application.

Parameters:

application_arn (ApplicationArn) –

Specifies the ARN of the application with the authentication method to add or update.
authentication_method_type (AuthenticationMethodType) –

Specifies the type of the authentication method that you want to add or update.
authentication_method (AuthenticationMethod) –

Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the AuthenticationMethodType parameter.

Raises:

AccessDeniedException –

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

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.
InternalServerException –

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

Indicates that a requested resource is not found.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
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_sso_admin/_services/sso_admin.py

def put_application_authentication_method(
    self,
    application_arn: "capo_sso_admin.types.application_arn.ApplicationArn",
    authentication_method_type: "capo_sso_admin.types.authentication_method_type.AuthenticationMethodType",
    authentication_method: "capo_sso_admin.types.authentication_method.AuthenticationMethod",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> None:
    """<p>Adds or updates an authentication method for an application.</p>

    Args:
        application_arn: <p>Specifies the ARN of the application with the authentication method to add or update.</p>
        authentication_method_type: <p>Specifies the type of the authentication method that you want to add or update.</p>
        authentication_method: <p>Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the <code>AuthenticationMethodType</code> parameter.</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.put_application_authentication_method_request.PutApplicationAuthenticationMethodRequest]",
    ) -> OperationResponse[None]:
        import capo_sso_admin._operations.swb_external_service.put_application_authentication_method

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutApplicationAuthenticationMethod")
    )
    input_: capo_sso_admin.types.put_application_authentication_method_request.PutApplicationAuthenticationMethodRequest = {
        "application_arn": application_arn,
        "authentication_method_type": authentication_method_type,
        "authentication_method": authentication_method,
    }

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