Skip to content

Operation

Source code in docs_src/capo_servicediscovery/types/operation.py
class Operation(TypedDict, closed=True):
    id: NotRequired["capo_servicediscovery.types.operation_id.OperationId"]
    """<p>The ID of the operation that you want to get information about.</p>"""
    owner_account: NotRequired[
        "capo_servicediscovery.types.aws_account_id.AWSAccountId"
    ]
    """<p>The ID of the Amazon Web Services account that owns the namespace associated with the operation.</p>"""
    type: NotRequired["capo_servicediscovery.types.operation_type.OperationType"]
    """<p>The name of the operation that's associated with the specified ID.</p>"""
    status: NotRequired["capo_servicediscovery.types.operation_status.OperationStatus"]
    """<p>The status of the operation. Values include the following:</p> <dl> <dt>SUBMITTED</dt> <dd> <p>This is the initial state that occurs immediately after you submit a request.</p> </dd> <dt>PENDING</dt> <dd> <p>Cloud Map is performing the operation.</p> </dd> <dt>SUCCESS</dt> <dd> <p>The operation succeeded.</p> </dd> <dt>FAIL</dt> <dd> <p>The operation failed. For the failure reason, see <code>ErrorMessage</code>.</p> </dd> </dl>"""
    error_message: NotRequired["capo_servicediscovery.types.message.Message"]
    """<p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation failed.</p>"""
    error_code: NotRequired["capo_servicediscovery.types.code.Code"]
    """<p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code> include the following:</p> <ul> <li> <p> <code>ACCESS_DENIED</code> </p> </li> <li> <p> <code>CANNOT_CREATE_HOSTED_ZONE</code> </p> </li> <li> <p> <code>EXPIRED_TOKEN</code> </p> </li> <li> <p> <code>HOSTED_ZONE_NOT_FOUND</code> </p> </li> <li> <p> <code>INTERNAL_FAILURE</code> </p> </li> <li> <p> <code>INVALID_CHANGE_BATCH</code> </p> </li> <li> <p> <code>THROTTLED_REQUEST</code> </p> </li> </ul>"""
    create_date: NotRequired["capo_servicediscovery.types.timestamp.Timestamp"]
    """<p>The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    update_date: NotRequired["capo_servicediscovery.types.timestamp.Timestamp"]
    """<p>The date and time that the value of <code>Status</code> changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    targets: NotRequired[
        "capo_servicediscovery.types.operation_targets_map.OperationTargetsMap"
    ]
    """<p>The name of the target entity that's associated with the operation:</p> <dl> <dt>NAMESPACE</dt> <dd> <p>The namespace ID is returned in the <code>ResourceId</code> property.</p> </dd> <dt>SERVICE</dt> <dd> <p>The service ID is returned in the <code>ResourceId</code> property.</p> </dd> <dt>INSTANCE</dt> <dd> <p>The instance ID is returned in the <code>ResourceId</code> property.</p> </dd> </dl>"""

create_date instance-attribute

create_date: NotRequired[Timestamp]

The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

error_code instance-attribute

error_code: NotRequired[Code]

The code associated with ErrorMessage. Values for ErrorCode include the following:

  • ACCESS_DENIED

  • CANNOT_CREATE_HOSTED_ZONE

  • EXPIRED_TOKEN

  • HOSTED_ZONE_NOT_FOUND

  • INTERNAL_FAILURE

  • INVALID_CHANGE_BATCH

  • THROTTLED_REQUEST

error_message instance-attribute

error_message: NotRequired[Message]

If the value of Status is FAIL, the reason that the operation failed.

id instance-attribute

id: NotRequired[OperationId]

The ID of the operation that you want to get information about.

owner_account instance-attribute

owner_account: NotRequired[AWSAccountId]

The ID of the Amazon Web Services account that owns the namespace associated with the operation.

status instance-attribute

status: NotRequired[OperationStatus]

The status of the operation. Values include the following:

SUBMITTED

This is the initial state that occurs immediately after you submit a request.

PENDING

Cloud Map is performing the operation.

SUCCESS

The operation succeeded.

FAIL

The operation failed. For the failure reason, see ErrorMessage.

targets instance-attribute

targets: NotRequired[OperationTargetsMap]

The name of the target entity that's associated with the operation:

NAMESPACE

The namespace ID is returned in the ResourceId property.

SERVICE

The service ID is returned in the ResourceId property.

INSTANCE

The instance ID is returned in the ResourceId property.

type instance-attribute

type: NotRequired[OperationType]

The name of the operation that's associated with the specified ID.

update_date instance-attribute

update_date: NotRequired[Timestamp]

The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.