response

Data model for API responses.

class aws_ssm_run_command.better_boto.response.Command(CommandId: str, DocumentName: ~typing.Optional[str] = None, DocumentVersion: ~typing.Optional[str] = None, Comment: ~typing.Optional[str] = None, ExpiresAfter: ~typing.Optional[~datetime.datetime] = None, Parameters: ~typing.Dict[str, ~typing.List[str]] = <factory>, InstanceIds: ~typing.List[str] = <factory>, Targets: ~typing.List[~typing.Dict[str, ~typing.Union[str, ~typing.List[str]]]] = <factory>, RequestedDateTime: ~typing.Optional[~datetime.datetime] = None, Status: ~typing.Optional[str] = None, StatusDetails: ~typing.Optional[str] = None, OutputS3Region: ~typing.Optional[str] = None, OutputS3BucketName: ~typing.Optional[str] = None, OutputS3KeyPrefix: ~typing.Optional[str] = None, MaxConcurrency: ~typing.Optional[str] = None, MaxErrors: ~typing.Optional[str] = None, TargetCount: ~typing.Optional[int] = None, CompletedCount: ~typing.Optional[int] = None, ErrorCount: ~typing.Optional[int] = None, DeliveryTimedOutCount: ~typing.Optional[int] = None, ServiceRole: ~typing.Optional[str] = None, NotificationConfig: ~typing.Dict[str, ~typing.Any] = <factory>, CloudWatchOutputConfig: ~typing.Dict[str, ~typing.Any] = <factory>, TimeoutSeconds: ~typing.Optional[int] = None, AlarmConfiguration: ~typing.Dict[str, ~typing.Any] = <factory>, TriggeredAlarms: ~typing.List[~typing.Dict[str, ~typing.Any]] = <factory>, data: ~typing.Dict[str, ~typing.Any] = <factory>)

Represents a Command details returned from a send_command API call.

classmethod from_send_command_response(response: dict)

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm/client/get_command_invocation.html

class aws_ssm_run_command.better_boto.response.CommandInvocationStatusEnum(value)

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm/client/get_command_invocation.html

class aws_ssm_run_command.better_boto.response.CommandInvocation(CommandId: str, InstanceId: ~typing.Optional[str] = None, Comment: ~typing.Optional[str] = None, DocumentName: ~typing.Optional[str] = None, DocumentVersion: ~typing.Optional[str] = None, PluginName: ~typing.Optional[str] = None, ResponseCode: ~typing.Optional[int] = None, ExecutionStartDateTime: ~typing.Optional[str] = None, ExecutionElapsedTime: ~typing.Optional[str] = None, ExecutionEndDateTime: ~typing.Optional[str] = None, Status: ~typing.Optional[str] = None, StatusDetails: ~typing.Optional[str] = None, StandardOutputContent: ~typing.Optional[str] = None, StandardOutputUrl: ~typing.Optional[str] = None, StandardErrorContent: ~typing.Optional[str] = None, StandardErrorUrl: ~typing.Optional[str] = None, CloudWatchOutputConfig: dict = <factory>)

Represents a Command Invocation details returned from a get_command_invocation API call.

classmethod from_get_command_invocation_response(response: dict)

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm/client/get_command_invocation.html

classmethod get(ssm_client: SSMClient, command_id: str, instance_id: str) → CommandInvocation

A wrapper around get_command_invocation API call.

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm/client/get_command_invocation.html

is_pending() → bool

Check if the command is pending

is_in_progress() → bool

Check if the command is in progress.

is_delayed() → bool

Check if the command is delayed.

is_success() → bool

Check if the command is successful.

is_cancelled() → bool

Check if the command is cancelled.

is_timed_out() → bool

Check if the command is timed out.

is_failed() → bool

Check if the command failed.

is_cancelling() → bool

Check if the command is in the process of cancelling.