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
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.
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)
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
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
def cancel_batch_job_execution(
self,
*,
applicationId: str,
executionId: str,
) -> Dict[str, Any]:
...
kwargs: CancelBatchJobExecutionRequestRequestTypeDef = { # (1)
"applicationId": ...,
"executionId": ...,
}
parent.cancel_batch_job_execution(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("m2").close
method.
boto3 documentation
create_application
Creates a new application with given parameters.
Type annotations and code completion for boto3.client("m2").create_application
method.
boto3 documentation
def create_application(
self,
*,
definition: DefinitionTypeDef, # (1)
engineType: EngineTypeType, # (2)
name: str,
clientToken: str = ...,
description: str = ...,
kmsKeyId: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateApplicationResponseTypeDef: # (3)
...
kwargs: CreateApplicationRequestRequestTypeDef = { # (1)
"definition": ...,
"engineType": ...,
"name": ...,
}
parent.create_application(**kwargs)
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
def create_data_set_import_task(
self,
*,
applicationId: str,
importConfig: DataSetImportConfigTypeDef, # (1)
clientToken: str = ...,
) -> CreateDataSetImportTaskResponseTypeDef: # (2)
...
kwargs: CreateDataSetImportTaskRequestRequestTypeDef = { # (1)
"applicationId": ...,
"importConfig": ...,
}
parent.create_data_set_import_task(**kwargs)
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
def create_deployment(
self,
*,
applicationId: str,
applicationVersion: int,
environmentId: str,
clientToken: str = ...,
) -> CreateDeploymentResponseTypeDef: # (1)
...
kwargs: CreateDeploymentRequestRequestTypeDef = { # (1)
"applicationId": ...,
"applicationVersion": ...,
"environmentId": ...,
}
parent.create_deployment(**kwargs)
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
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)
...
- See EngineTypeType
- See HighAvailabilityConfigTypeDef
- See StorageConfigurationTypeDef
- See CreateEnvironmentResponseTypeDef
kwargs: CreateEnvironmentRequestRequestTypeDef = { # (1)
"engineType": ...,
"instanceType": ...,
"name": ...,
}
parent.create_environment(**kwargs)
delete_application
Deletes a specific application.
Type annotations and code completion for boto3.client("m2").delete_application
method.
boto3 documentation
kwargs: DeleteApplicationRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.delete_application(**kwargs)
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
def delete_application_from_environment(
self,
*,
applicationId: str,
environmentId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteApplicationFromEnvironmentRequestRequestTypeDef = { # (1)
"applicationId": ...,
"environmentId": ...,
}
parent.delete_application_from_environment(**kwargs)
delete_environment
Deletes a specific runtime environment.
Type annotations and code completion for boto3.client("m2").delete_environment
method.
boto3 documentation
kwargs: DeleteEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.delete_environment(**kwargs)
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
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
def get_application(
self,
*,
applicationId: str,
) -> GetApplicationResponseTypeDef: # (1)
...
kwargs: GetApplicationRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.get_application(**kwargs)
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
def get_application_version(
self,
*,
applicationId: str,
applicationVersion: int,
) -> GetApplicationVersionResponseTypeDef: # (1)
...
kwargs: GetApplicationVersionRequestRequestTypeDef = { # (1)
"applicationId": ...,
"applicationVersion": ...,
}
parent.get_application_version(**kwargs)
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
def get_batch_job_execution(
self,
*,
applicationId: str,
executionId: str,
) -> GetBatchJobExecutionResponseTypeDef: # (1)
...
kwargs: GetBatchJobExecutionRequestRequestTypeDef = { # (1)
"applicationId": ...,
"executionId": ...,
}
parent.get_batch_job_execution(**kwargs)
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
def get_data_set_details(
self,
*,
applicationId: str,
dataSetName: str,
) -> GetDataSetDetailsResponseTypeDef: # (1)
...
kwargs: GetDataSetDetailsRequestRequestTypeDef = { # (1)
"applicationId": ...,
"dataSetName": ...,
}
parent.get_data_set_details(**kwargs)
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
def get_data_set_import_task(
self,
*,
applicationId: str,
taskId: str,
) -> GetDataSetImportTaskResponseTypeDef: # (1)
...
kwargs: GetDataSetImportTaskRequestRequestTypeDef = { # (1)
"applicationId": ...,
"taskId": ...,
}
parent.get_data_set_import_task(**kwargs)
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
def get_deployment(
self,
*,
applicationId: str,
deploymentId: str,
) -> GetDeploymentResponseTypeDef: # (1)
...
kwargs: GetDeploymentRequestRequestTypeDef = { # (1)
"applicationId": ...,
"deploymentId": ...,
}
parent.get_deployment(**kwargs)
get_environment
Describes a specific runtime environment.
Type annotations and code completion for boto3.client("m2").get_environment
method.
boto3 documentation
def get_environment(
self,
*,
environmentId: str,
) -> GetEnvironmentResponseTypeDef: # (1)
...
kwargs: GetEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.get_environment(**kwargs)
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
def list_application_versions(
self,
*,
applicationId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListApplicationVersionsResponseTypeDef: # (1)
...
kwargs: ListApplicationVersionsRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.list_application_versions(**kwargs)
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
def list_applications(
self,
*,
environmentId: str = ...,
maxResults: int = ...,
names: Sequence[str] = ...,
nextToken: str = ...,
) -> ListApplicationsResponseTypeDef: # (1)
...
kwargs: ListApplicationsRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.list_applications(**kwargs)
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
def list_batch_job_definitions(
self,
*,
applicationId: str,
maxResults: int = ...,
nextToken: str = ...,
prefix: str = ...,
) -> ListBatchJobDefinitionsResponseTypeDef: # (1)
...
kwargs: ListBatchJobDefinitionsRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.list_batch_job_definitions(**kwargs)
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
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)
...
kwargs: ListBatchJobExecutionsRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.list_batch_job_executions(**kwargs)
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
def list_data_set_import_history(
self,
*,
applicationId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDataSetImportHistoryResponseTypeDef: # (1)
...
kwargs: ListDataSetImportHistoryRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.list_data_set_import_history(**kwargs)
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
def list_data_sets(
self,
*,
applicationId: str,
maxResults: int = ...,
nextToken: str = ...,
prefix: str = ...,
) -> ListDataSetsResponseTypeDef: # (1)
...
kwargs: ListDataSetsRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.list_data_sets(**kwargs)
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
def list_deployments(
self,
*,
applicationId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDeploymentsResponseTypeDef: # (1)
...
kwargs: ListDeploymentsRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.list_deployments(**kwargs)
list_engine_versions
Lists the available engine versions.
Type annotations and code completion for boto3.client("m2").list_engine_versions
method.
boto3 documentation
def list_engine_versions(
self,
*,
engineType: EngineTypeType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListEngineVersionsResponseTypeDef: # (2)
...
kwargs: ListEngineVersionsRequestRequestTypeDef = { # (1)
"engineType": ...,
}
parent.list_engine_versions(**kwargs)
list_environments
Lists the runtime environments.
Type annotations and code completion for boto3.client("m2").list_environments
method.
boto3 documentation
def list_environments(
self,
*,
engineType: EngineTypeType = ..., # (1)
maxResults: int = ...,
names: Sequence[str] = ...,
nextToken: str = ...,
) -> ListEnvironmentsResponseTypeDef: # (2)
...
kwargs: ListEnvironmentsRequestRequestTypeDef = { # (1)
"engineType": ...,
}
parent.list_environments(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
start_application
Starts an application that is currently stopped.
Type annotations and code completion for boto3.client("m2").start_application
method.
boto3 documentation
kwargs: StartApplicationRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.start_application(**kwargs)
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
def start_batch_job(
self,
*,
applicationId: str,
batchJobIdentifier: BatchJobIdentifierTypeDef, # (1)
jobParams: Mapping[str, str] = ...,
) -> StartBatchJobResponseTypeDef: # (2)
...
kwargs: StartBatchJobRequestRequestTypeDef = { # (1)
"applicationId": ...,
"batchJobIdentifier": ...,
}
parent.start_batch_job(**kwargs)
stop_application
Stops a running application.
Type annotations and code completion for boto3.client("m2").stop_application
method.
boto3 documentation
def stop_application(
self,
*,
applicationId: str,
forceStop: bool = ...,
) -> Dict[str, Any]:
...
kwargs: StopApplicationRequestRequestTypeDef = { # (1)
"applicationId": ...,
}
parent.stop_application(**kwargs)
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
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
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
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_application
Updates an application and creates a new version.
Type annotations and code completion for boto3.client("m2").update_application
method.
boto3 documentation
def update_application(
self,
*,
applicationId: str,
currentApplicationVersion: int,
definition: DefinitionTypeDef = ..., # (1)
description: str = ...,
) -> UpdateApplicationResponseTypeDef: # (2)
...
kwargs: UpdateApplicationRequestRequestTypeDef = { # (1)
"applicationId": ...,
"currentApplicationVersion": ...,
}
parent.update_application(**kwargs)
update_environment
Updates the configuration details for a specific runtime environment.
Type annotations and code completion for boto3.client("m2").update_environment
method.
boto3 documentation
def update_environment(
self,
*,
environmentId: str,
applyDuringMaintenanceWindow: bool = ...,
desiredCapacity: int = ...,
engineVersion: str = ...,
instanceType: str = ...,
preferredMaintenanceWindow: str = ...,
) -> UpdateEnvironmentResponseTypeDef: # (1)
...
kwargs: UpdateEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.update_environment(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("m2").get_paginator
method with overloads.
client.get_paginator("list_application_versions")
-> ListApplicationVersionsPaginatorclient.get_paginator("list_applications")
-> ListApplicationsPaginatorclient.get_paginator("list_batch_job_definitions")
-> ListBatchJobDefinitionsPaginatorclient.get_paginator("list_batch_job_executions")
-> ListBatchJobExecutionsPaginatorclient.get_paginator("list_data_set_import_history")
-> ListDataSetImportHistoryPaginatorclient.get_paginator("list_data_sets")
-> ListDataSetsPaginatorclient.get_paginator("list_deployments")
-> ListDeploymentsPaginatorclient.get_paginator("list_engine_versions")
-> ListEngineVersionsPaginatorclient.get_paginator("list_environments")
-> ListEnvironmentsPaginator