AgentRegistryControl / Client / update_registry_record_status

update_registry_record_status

AgentRegistryControl.Client.update_registry_record_status(**kwargs)

Updates the status of a registry record as part of the registry’s curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable

See also: AWS API Documentation

Request Syntax

response = client.update_registry_record_status(
    registryId='string',
    recordId='string',
    status='DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    statusReason='string'
)

Parameters:

• registryId (string) –

  [REQUIRED]

  The identifier of the registry containing the record (ARN or ID)

• recordId (string) –

  [REQUIRED]

  The identifier of the registry record to update the status of (ARN or ID)

• status (string) –

  [REQUIRED]

  The target status for the registry record

• statusReason (string) –

  [REQUIRED]

  The reason for the status change, for example why the record was approved, rejected, or deprecated

Return type:

dict

Returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'statusReason': 'string',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  Response structure for updating a registry record status

  • registryArn (string) –

    The ARN of the registry

  • recordArn (string) –

    The ARN of the registry record

  • recordId (string) –

    The ID of the registry record

  • status (string) –

    The resulting status of the registry record

  • statusReason (string) –

    The reason for the status change

  • updatedAt (datetime) –

    The timestamp when the record was last updated

Exceptions

• AgentRegistryControl.Client.exceptions.InternalServerException

• AgentRegistryControl.Client.exceptions.AccessDeniedException

• AgentRegistryControl.Client.exceptions.ResourceNotFoundException

• AgentRegistryControl.Client.exceptions.ThrottlingException

• AgentRegistryControl.Client.exceptions.ValidationException

• AgentRegistryControl.Client.exceptions.ConflictException