OpsWorks / Client / describe_service_errors

describe_service_errors#

OpsWorks.Client.describe_service_errors(**kwargs)#

Describes OpsWorks Stacks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

See also: AWS API Documentation

Request Syntax

response = client.describe_service_errors(
    StackId='string',
    InstanceId='string',
    ServiceErrorIds=[
        'string',
    ]
)
Parameters:

  • StackId (string) – The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

  • InstanceId (string) – The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

  • ServiceErrorIds (list) –

    An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ServiceErrors': [
        {
            'ServiceErrorId': 'string',
            'StackId': 'string',
            'InstanceId': 'string',
            'Type': 'string',
            'Message': 'string',
            'CreatedAt': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    Contains the response to a DescribeServiceErrors request.

    • ServiceErrors (list) –

      An array of ServiceError objects that describe the specified service errors.

      • (dict) –

        Describes an OpsWorks Stacks service error.

        • ServiceErrorId (string) –

          The error ID.

        • StackId (string) –

          The stack ID.

        • InstanceId (string) –

          The instance ID.

        • Type (string) –

          The error type.

        • Message (string) –

          A message that describes the error.

        • CreatedAt (string) –

          When the error occurred.

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException