SsmSap / Client / stop_application

stop_application#

SsmSap.Client.stop_application(**kwargs)#

Request is an operation to stop an application.

Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

See also: AWS API Documentation

Request Syntax

response = client.stop_application(
    ApplicationId='string',
    StopConnectedEntity='DBMS',
    IncludeEc2InstanceShutdown=True|False
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The ID of the application.

  • StopConnectedEntity (string) –

    Specify the ConnectedEntityType. Accepted type is DBMS.

    If this parameter is included, the connected DBMS (Database Management System) will be stopped.

  • IncludeEc2InstanceShutdown (boolean) – Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

  • (dict) –

    • OperationId (string) –

      The ID of the operation.

Exceptions

  • SsmSap.Client.exceptions.ResourceNotFoundException

  • SsmSap.Client.exceptions.ValidationException

  • SsmSap.Client.exceptions.ConflictException

  • SsmSap.Client.exceptions.InternalServerException