Skip to content

MainframeModernizationClient

Index > MainframeModernization > MainframeModernizationClient

Auto-generated documentation for MainframeModernization type annotations stubs module mypy-boto3-m2.

MainframeModernizationClient

Type annotations and code completion for boto3.client("m2"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_m2.client import MainframeModernizationClient

def get_m2_client() -> MainframeModernizationClient:
    return Session().client("m2")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("m2").exceptions structure.

Usage example
client = boto3.client("m2")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_m2.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("m2").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_batch_job_execution

Cancels the running of a specific batch job execution.

Type annotations and code completion for boto3.client("m2").cancel_batch_job_execution method. boto3 documentation

Method definition
def cancel_batch_job_execution(
    self,
    *,
    applicationId: str,
    executionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelBatchJobExecutionRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "executionId": ...,
}

parent.cancel_batch_job_execution(**kwargs)
  1. See CancelBatchJobExecutionRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("m2").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_application

Creates a new application with given parameters.

Type annotations and code completion for boto3.client("m2").create_application method. boto3 documentation

Method definition
def create_application(
    self,
    *,
    definition: DefinitionTypeDef,  # (1)
    engineType: EngineTypeType,  # (2)
    name: str,
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateApplicationResponseTypeDef:  # (3)
    ...
  1. See DefinitionTypeDef
  2. See EngineTypeType
  3. See CreateApplicationResponseTypeDef
Usage example with kwargs
kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "definition": ...,
    "engineType": ...,
    "name": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

create_data_set_import_task

Starts a data set import task for a specific application.

Type annotations and code completion for boto3.client("m2").create_data_set_import_task method. boto3 documentation

Method definition
def create_data_set_import_task(
    self,
    *,
    applicationId: str,
    importConfig: DataSetImportConfigTypeDef,  # (1)
    clientToken: str = ...,
) -> CreateDataSetImportTaskResponseTypeDef:  # (2)
    ...
  1. See DataSetImportConfigTypeDef
  2. See CreateDataSetImportTaskResponseTypeDef
Usage example with kwargs
kwargs: CreateDataSetImportTaskRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "importConfig": ...,
}

parent.create_data_set_import_task(**kwargs)
  1. See CreateDataSetImportTaskRequestRequestTypeDef

create_deployment

Creates and starts a deployment to deploy an application into an environment.

Type annotations and code completion for boto3.client("m2").create_deployment method. boto3 documentation

Method definition
def create_deployment(
    self,
    *,
    applicationId: str,
    applicationVersion: int,
    environmentId: str,
    clientToken: str = ...,
) -> CreateDeploymentResponseTypeDef:  # (1)
    ...
  1. See CreateDeploymentResponseTypeDef
Usage example with kwargs
kwargs: CreateDeploymentRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "applicationVersion": ...,
    "environmentId": ...,
}

parent.create_deployment(**kwargs)
  1. See CreateDeploymentRequestRequestTypeDef

create_environment

Creates a runtime environment for a given runtime engine.

Type annotations and code completion for boto3.client("m2").create_environment method. boto3 documentation

Method definition
def create_environment(
    self,
    *,
    engineType: EngineTypeType,  # (1)
    instanceType: str,
    name: str,
    clientToken: str = ...,
    description: str = ...,
    engineVersion: str = ...,
    highAvailabilityConfig: HighAvailabilityConfigTypeDef = ...,  # (2)
    preferredMaintenanceWindow: str = ...,
    publiclyAccessible: bool = ...,
    securityGroupIds: Sequence[str] = ...,
    storageConfigurations: Sequence[StorageConfigurationTypeDef] = ...,  # (3)
    subnetIds: Sequence[str] = ...,
    tags: Mapping[str, str] = ...,
) -> CreateEnvironmentResponseTypeDef:  # (4)
    ...
  1. See EngineTypeType
  2. See HighAvailabilityConfigTypeDef
  3. See StorageConfigurationTypeDef
  4. See CreateEnvironmentResponseTypeDef
Usage example with kwargs
kwargs: CreateEnvironmentRequestRequestTypeDef = {  # (1)
    "engineType": ...,
    "instanceType": ...,
    "name": ...,
}

parent.create_environment(**kwargs)
  1. See CreateEnvironmentRequestRequestTypeDef

delete_application

Deletes a specific application.

Type annotations and code completion for boto3.client("m2").delete_application method. boto3 documentation

Method definition
def delete_application(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestRequestTypeDef

delete_application_from_environment

Deletes a specific application from a specified environment where it has been previously deployed.

Type annotations and code completion for boto3.client("m2").delete_application_from_environment method. boto3 documentation

Method definition
def delete_application_from_environment(
    self,
    *,
    applicationId: str,
    environmentId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteApplicationFromEnvironmentRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "environmentId": ...,
}

parent.delete_application_from_environment(**kwargs)
  1. See DeleteApplicationFromEnvironmentRequestRequestTypeDef

delete_environment

Deletes a specific environment.

Type annotations and code completion for boto3.client("m2").delete_environment method. boto3 documentation

Method definition
def delete_environment(
    self,
    *,
    environmentId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEnvironmentRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.delete_environment(**kwargs)
  1. See DeleteEnvironmentRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("m2").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_application

Describes the details of a specific application.

Type annotations and code completion for boto3.client("m2").get_application method. boto3 documentation

Method definition
def get_application(
    self,
    *,
    applicationId: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...
  1. See GetApplicationResponseTypeDef
Usage example with kwargs
kwargs: GetApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.get_application(**kwargs)
  1. See GetApplicationRequestRequestTypeDef

get_application_version

Returns details about a specific version of a specific application.

Type annotations and code completion for boto3.client("m2").get_application_version method. boto3 documentation

Method definition
def get_application_version(
    self,
    *,
    applicationId: str,
    applicationVersion: int,
) -> GetApplicationVersionResponseTypeDef:  # (1)
    ...
  1. See GetApplicationVersionResponseTypeDef
Usage example with kwargs
kwargs: GetApplicationVersionRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "applicationVersion": ...,
}

parent.get_application_version(**kwargs)
  1. See GetApplicationVersionRequestRequestTypeDef

get_batch_job_execution

Gets the details of a specific batch job execution for a specific application.

Type annotations and code completion for boto3.client("m2").get_batch_job_execution method. boto3 documentation

Method definition
def get_batch_job_execution(
    self,
    *,
    applicationId: str,
    executionId: str,
) -> GetBatchJobExecutionResponseTypeDef:  # (1)
    ...
  1. See GetBatchJobExecutionResponseTypeDef
Usage example with kwargs
kwargs: GetBatchJobExecutionRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "executionId": ...,
}

parent.get_batch_job_execution(**kwargs)
  1. See GetBatchJobExecutionRequestRequestTypeDef

get_data_set_details

Gets the details of a specific data set.

Type annotations and code completion for boto3.client("m2").get_data_set_details method. boto3 documentation

Method definition
def get_data_set_details(
    self,
    *,
    applicationId: str,
    dataSetName: str,
) -> GetDataSetDetailsResponseTypeDef:  # (1)
    ...
  1. See GetDataSetDetailsResponseTypeDef
Usage example with kwargs
kwargs: GetDataSetDetailsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataSetName": ...,
}

parent.get_data_set_details(**kwargs)
  1. See GetDataSetDetailsRequestRequestTypeDef

get_data_set_import_task

Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.

Type annotations and code completion for boto3.client("m2").get_data_set_import_task method. boto3 documentation

Method definition
def get_data_set_import_task(
    self,
    *,
    applicationId: str,
    taskId: str,
) -> GetDataSetImportTaskResponseTypeDef:  # (1)
    ...
  1. See GetDataSetImportTaskResponseTypeDef
Usage example with kwargs
kwargs: GetDataSetImportTaskRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "taskId": ...,
}

parent.get_data_set_import_task(**kwargs)
  1. See GetDataSetImportTaskRequestRequestTypeDef

get_deployment

Gets details of a specific deployment with a given deployment identifier.

Type annotations and code completion for boto3.client("m2").get_deployment method. boto3 documentation

Method definition
def get_deployment(
    self,
    *,
    applicationId: str,
    deploymentId: str,
) -> GetDeploymentResponseTypeDef:  # (1)
    ...
  1. See GetDeploymentResponseTypeDef
Usage example with kwargs
kwargs: GetDeploymentRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "deploymentId": ...,
}

parent.get_deployment(**kwargs)
  1. See GetDeploymentRequestRequestTypeDef

get_environment

Describes a specific runtime environment.

Type annotations and code completion for boto3.client("m2").get_environment method. boto3 documentation

Method definition
def get_environment(
    self,
    *,
    environmentId: str,
) -> GetEnvironmentResponseTypeDef:  # (1)
    ...
  1. See GetEnvironmentResponseTypeDef
Usage example with kwargs
kwargs: GetEnvironmentRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.get_environment(**kwargs)
  1. See GetEnvironmentRequestRequestTypeDef

list_application_versions

Returns a list of the application versions for a specific application.

Type annotations and code completion for boto3.client("m2").list_application_versions method. boto3 documentation

Method definition
def list_application_versions(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListApplicationVersionsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListApplicationVersionsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_application_versions(**kwargs)
  1. See ListApplicationVersionsRequestRequestTypeDef

list_applications

Lists the applications associated with a specific Amazon Web Services account.

Type annotations and code completion for boto3.client("m2").list_applications method. boto3 documentation

Method definition
def list_applications(
    self,
    *,
    environmentId: str = ...,
    maxResults: int = ...,
    names: Sequence[str] = ...,
    nextToken: str = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationsResponseTypeDef
Usage example with kwargs
kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestRequestTypeDef

list_batch_job_definitions

Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.

Type annotations and code completion for boto3.client("m2").list_batch_job_definitions method. boto3 documentation

Method definition
def list_batch_job_definitions(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    prefix: str = ...,
) -> ListBatchJobDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListBatchJobDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListBatchJobDefinitionsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_batch_job_definitions(**kwargs)
  1. See ListBatchJobDefinitionsRequestRequestTypeDef

list_batch_job_executions

Lists historical, current, and scheduled batch job executions for a specific application.

Type annotations and code completion for boto3.client("m2").list_batch_job_executions method. boto3 documentation

Method definition
def list_batch_job_executions(
    self,
    *,
    applicationId: str,
    executionIds: Sequence[str] = ...,
    jobName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    startedAfter: Union[datetime, str] = ...,
    startedBefore: Union[datetime, str] = ...,
    status: BatchJobExecutionStatusType = ...,  # (1)
) -> ListBatchJobExecutionsResponseTypeDef:  # (2)
    ...
  1. See BatchJobExecutionStatusType
  2. See ListBatchJobExecutionsResponseTypeDef
Usage example with kwargs
kwargs: ListBatchJobExecutionsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_batch_job_executions(**kwargs)
  1. See ListBatchJobExecutionsRequestRequestTypeDef

list_data_set_import_history

Lists the data set imports for the specified application.

Type annotations and code completion for boto3.client("m2").list_data_set_import_history method. boto3 documentation

Method definition
def list_data_set_import_history(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDataSetImportHistoryResponseTypeDef:  # (1)
    ...
  1. See ListDataSetImportHistoryResponseTypeDef
Usage example with kwargs
kwargs: ListDataSetImportHistoryRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_data_set_import_history(**kwargs)
  1. See ListDataSetImportHistoryRequestRequestTypeDef

list_data_sets

Lists the data sets imported for a specific application.

Type annotations and code completion for boto3.client("m2").list_data_sets method. boto3 documentation

Method definition
def list_data_sets(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    prefix: str = ...,
) -> ListDataSetsResponseTypeDef:  # (1)
    ...
  1. See ListDataSetsResponseTypeDef
Usage example with kwargs
kwargs: ListDataSetsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_data_sets(**kwargs)
  1. See ListDataSetsRequestRequestTypeDef

list_deployments

Returns a list of all deployments of a specific application.

Type annotations and code completion for boto3.client("m2").list_deployments method. boto3 documentation

Method definition
def list_deployments(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDeploymentsResponseTypeDef:  # (1)
    ...
  1. See ListDeploymentsResponseTypeDef
Usage example with kwargs
kwargs: ListDeploymentsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_deployments(**kwargs)
  1. See ListDeploymentsRequestRequestTypeDef

list_engine_versions

Lists the available engine versions.

Type annotations and code completion for boto3.client("m2").list_engine_versions method. boto3 documentation

Method definition
def list_engine_versions(
    self,
    *,
    engineType: EngineTypeType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEngineVersionsResponseTypeDef:  # (2)
    ...
  1. See EngineTypeType
  2. See ListEngineVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListEngineVersionsRequestRequestTypeDef = {  # (1)
    "engineType": ...,
}

parent.list_engine_versions(**kwargs)
  1. See ListEngineVersionsRequestRequestTypeDef

list_environments

Lists the runtime environments.

Type annotations and code completion for boto3.client("m2").list_environments method. boto3 documentation

Method definition
def list_environments(
    self,
    *,
    engineType: EngineTypeType = ...,  # (1)
    maxResults: int = ...,
    names: Sequence[str] = ...,
    nextToken: str = ...,
) -> ListEnvironmentsResponseTypeDef:  # (2)
    ...
  1. See EngineTypeType
  2. See ListEnvironmentsResponseTypeDef
Usage example with kwargs
kwargs: ListEnvironmentsRequestRequestTypeDef = {  # (1)
    "engineType": ...,
}

parent.list_environments(**kwargs)
  1. See ListEnvironmentsRequestRequestTypeDef

list_tags_for_resource

Lists the tags for the specified resource.

Type annotations and code completion for boto3.client("m2").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_application

Starts an application that is currently stopped.

Type annotations and code completion for boto3.client("m2").start_application method. boto3 documentation

Method definition
def start_application(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: StartApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.start_application(**kwargs)
  1. See StartApplicationRequestRequestTypeDef

start_batch_job

Starts a batch job and returns the unique identifier of this execution of the batch job.

Type annotations and code completion for boto3.client("m2").start_batch_job method. boto3 documentation

Method definition
def start_batch_job(
    self,
    *,
    applicationId: str,
    batchJobIdentifier: BatchJobIdentifierTypeDef,  # (1)
    jobParams: Mapping[str, str] = ...,
) -> StartBatchJobResponseTypeDef:  # (2)
    ...
  1. See BatchJobIdentifierTypeDef
  2. See StartBatchJobResponseTypeDef
Usage example with kwargs
kwargs: StartBatchJobRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "batchJobIdentifier": ...,
}

parent.start_batch_job(**kwargs)
  1. See StartBatchJobRequestRequestTypeDef

stop_application

Stops a running application.

Type annotations and code completion for boto3.client("m2").stop_application method. boto3 documentation

Method definition
def stop_application(
    self,
    *,
    applicationId: str,
    forceStop: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: StopApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.stop_application(**kwargs)
  1. See StopApplicationRequestRequestTypeDef

tag_resource

Adds one or more tags to the specified resource.

Type annotations and code completion for boto3.client("m2").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes one or more tags from the specified resource.

Type annotations and code completion for boto3.client("m2").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_application

Updates an application and creates a new version.

Type annotations and code completion for boto3.client("m2").update_application method. boto3 documentation

Method definition
def update_application(
    self,
    *,
    applicationId: str,
    currentApplicationVersion: int,
    definition: DefinitionTypeDef = ...,  # (1)
    description: str = ...,
) -> UpdateApplicationResponseTypeDef:  # (2)
    ...
  1. See DefinitionTypeDef
  2. See UpdateApplicationResponseTypeDef
Usage example with kwargs
kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "currentApplicationVersion": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestRequestTypeDef

update_environment

Updates the configuration details for a specific environment.

Type annotations and code completion for boto3.client("m2").update_environment method. boto3 documentation

Method definition
def update_environment(
    self,
    *,
    environmentId: str,
    applyDuringMaintenanceWindow: bool = ...,
    desiredCapacity: int = ...,
    engineVersion: str = ...,
    instanceType: str = ...,
    preferredMaintenanceWindow: str = ...,
) -> UpdateEnvironmentResponseTypeDef:  # (1)
    ...
  1. See UpdateEnvironmentResponseTypeDef
Usage example with kwargs
kwargs: UpdateEnvironmentRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.update_environment(**kwargs)
  1. See UpdateEnvironmentRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("m2").get_paginator method with overloads.