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

# MainframeModernizationClient 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.

# Exceptions.exceptions usage example

client = boto3.client("m2")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ExecutionTimeoutException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions 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

# can_paginate 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

# cancel_batch_job_execution method definition

def cancel_batch_job_execution(
    self,
    *,
    applicationId: str,
    executionId: str,
) -> Dict[str, Any]:
    ...
# cancel_batch_job_execution method usage example with argument unpacking

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

# close 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

# create_application method definition

def create_application(
    self,
    *,
    definition: DefinitionTypeDef,  # (1)
    engineType: EngineTypeType,  # (2)
    name: str,
    clientToken: str = ...,
    description: str = ...,
    kmsKeyId: str = ...,
    roleArn: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateApplicationResponseTypeDef:  # (3)
    ...
  1. See DefinitionTypeDef
  2. See EngineTypeType
  3. See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking

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

# create_data_set_import_task method definition

def create_data_set_import_task(
    self,
    *,
    applicationId: str,
    importConfig: DataSetImportConfigTypeDef,  # (1)
    clientToken: str = ...,
) -> CreateDataSetImportTaskResponseTypeDef:  # (2)
    ...
  1. See DataSetImportConfigTypeDef
  2. See CreateDataSetImportTaskResponseTypeDef
# create_data_set_import_task method usage example with argument unpacking

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 a runtime environment.

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

# create_deployment method definition

def create_deployment(
    self,
    *,
    applicationId: str,
    applicationVersion: int,
    environmentId: str,
    clientToken: str = ...,
) -> CreateDeploymentResponseTypeDef:  # (1)
    ...
  1. See CreateDeploymentResponseTypeDef
# create_deployment method usage example with argument unpacking

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

# create_environment method definition

def create_environment(
    self,
    *,
    engineType: EngineTypeType,  # (1)
    instanceType: str,
    name: str,
    clientToken: str = ...,
    description: str = ...,
    engineVersion: str = ...,
    highAvailabilityConfig: HighAvailabilityConfigTypeDef = ...,  # (2)
    kmsKeyId: str = ...,
    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
# create_environment method usage example with argument unpacking

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

# delete_application method definition

def delete_application(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

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

delete_application_from_environment#

Deletes a specific application from the specific runtime environment where it was previously deployed.

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

# delete_application_from_environment method definition

def delete_application_from_environment(
    self,
    *,
    applicationId: str,
    environmentId: str,
) -> Dict[str, Any]:
    ...
# delete_application_from_environment method usage example with argument unpacking

kwargs: DeleteApplicationFromEnvironmentRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "environmentId": ...,
}

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

delete_environment#

Deletes a specific runtime environment.

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

# delete_environment method definition

def delete_environment(
    self,
    *,
    environmentId: str,
) -> Dict[str, Any]:
    ...
# delete_environment method usage example with argument unpacking

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

# generate_presigned_url 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.