Cancels a single metadata model creation operation that was started with StartMetadataModelCreation.
Required permissions: dms:CancelMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service.
Parameters:
-
migration_project_identifier
(MigrationProjectIdentifier)
–
The migration project name or Amazon Resource Name (ARN).
-
request_identifier
(String)
–
The identifier for the metadata model creation operation to cancel. This operation was initiated by StartMetadataModelCreation.
Raises:
Examples:
Cancel a metadata model creation
The following example cancels a metadata model creation operation.
>>> client.cancel_metadata_model_creation(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS', request_identifier='a1b2c3d4-5678-90ab-cdef-EXAMPLE11111')
Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
| def cancel_metadata_model_creation(
self,
migration_project_identifier: "capo_database_migration_service.types.migration_project_identifier.MigrationProjectIdentifier",
request_identifier: "capo_database_migration_service.types.string.String",
*,
config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> "capo_database_migration_service.types.cancel_metadata_model_creation_response.CancelMetadataModelCreationResponse":
"""<p>Cancels a single metadata model creation operation that was started with <code>StartMetadataModelCreation</code>.</p> <p> <b>Required permissions:</b> <code>dms:CancelMetadataModelCreation</code>. For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
Args:
migration_project_identifier: <p>The migration project name or Amazon Resource Name (ARN).</p>
request_identifier: <p>The identifier for the metadata model creation operation to cancel. This operation was initiated by <code>StartMetadataModelCreation</code>.</p>
Raises:
capo_database_migration_service.errors.access_denied_fault.AccessDeniedFault: <p>DMS was denied access to the endpoint. Check that the role is correctly configured.</p>
capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
Cancel a metadata model creation
The following example cancels a metadata model creation operation.
>>> client.cancel_metadata_model_creation(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS', request_identifier='a1b2c3d4-5678-90ab-cdef-EXAMPLE11111')
"""
def _handler(
req: "OperationRequest[capo_database_migration_service.types.cancel_metadata_model_creation_message.CancelMetadataModelCreationMessage]",
) -> OperationResponse[
"capo_database_migration_service.types.cancel_metadata_model_creation_response.CancelMetadataModelCreationResponse"
]:
import capo_database_migration_service._operations.amazon_dm_sv20160101.cancel_metadata_model_creation
output, http_response = (
capo_database_migration_service._operations.amazon_dm_sv20160101.cancel_metadata_model_creation.cancel_metadata_model_creation(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CancelMetadataModelCreation")
)
input_: capo_database_migration_service.types.cancel_metadata_model_creation_message.CancelMetadataModelCreationMessage = {
"migration_project_identifier": migration_project_identifier,
"request_identifier": request_identifier,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|