OpsWorksCMClient

Index > OpsWorksCM > OpsWorksCMClient

Auto-generated documentation for OpsWorksCM type annotations stubs module types-boto3-opsworkscm.

OpsWorksCMClient

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

# OpsWorksCMClient usage example

from boto3.session import Session
from types_boto3_opsworkscm.client import OpsWorksCMClient

def get_opsworkscm_client() -> OpsWorksCMClient:
    return Session().client("opsworkscm")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("opsworkscm")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidStateException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_opsworkscm.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

Type annotations and code completion for boto3.client("opsworkscm").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:
    ...

associate_node

Associates a new node with the server.

Type annotations and code completion for boto3.client("opsworkscm").associate_node method. boto3 documentation

# associate_node method definition

def associate_node(
    self,
    *,
    ServerName: str,
    NodeName: str,
    EngineAttributes: Sequence[EngineAttributeTypeDef],  # (1)
) -> AssociateNodeResponseTypeDef:  # (2)
    ...

1. See EngineAttributeTypeDef
2. See AssociateNodeResponseTypeDef

# associate_node method usage example with argument unpacking

kwargs: AssociateNodeRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
    "NodeName": ...,
    "EngineAttributes": ...,
}

parent.associate_node(**kwargs)

1. See AssociateNodeRequestRequestTypeDef

create_backup

Creates an application-level backup of a server.

Type annotations and code completion for boto3.client("opsworkscm").create_backup method. boto3 documentation

# create_backup method definition

def create_backup(
    self,
    *,
    ServerName: str,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateBackupResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateBackupResponseTypeDef

# create_backup method usage example with argument unpacking

kwargs: CreateBackupRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
}

parent.create_backup(**kwargs)

1. See CreateBackupRequestRequestTypeDef

create_server

Creates and immedately starts a new server.

Type annotations and code completion for boto3.client("opsworkscm").create_server method. boto3 documentation

# create_server method definition

def create_server(
    self,
    *,
    Engine: str,
    ServerName: str,
    InstanceProfileArn: str,
    InstanceType: str,
    ServiceRoleArn: str,
    AssociatePublicIpAddress: bool = ...,
    CustomDomain: str = ...,
    CustomCertificate: str = ...,
    CustomPrivateKey: str = ...,
    DisableAutomatedBackup: bool = ...,
    EngineModel: str = ...,
    EngineVersion: str = ...,
    EngineAttributes: Sequence[EngineAttributeTypeDef] = ...,  # (1)
    BackupRetentionCount: int = ...,
    KeyPair: str = ...,
    PreferredMaintenanceWindow: str = ...,
    PreferredBackupWindow: str = ...,
    SecurityGroupIds: Sequence[str] = ...,
    SubnetIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    BackupId: str = ...,
) -> CreateServerResponseTypeDef:  # (3)
    ...

1. See EngineAttributeTypeDef
2. See TagTypeDef
3. See CreateServerResponseTypeDef

# create_server method usage example with argument unpacking

kwargs: CreateServerRequestRequestTypeDef = {  # (1)
    "Engine": ...,
    "ServerName": ...,
    "InstanceProfileArn": ...,
    "InstanceType": ...,
    "ServiceRoleArn": ...,
}

parent.create_server(**kwargs)

1. See CreateServerRequestRequestTypeDef

delete_backup

Deletes a backup.

Type annotations and code completion for boto3.client("opsworkscm").delete_backup method. boto3 documentation

# delete_backup method definition

def delete_backup(
    self,
    *,
    BackupId: str,
) -> dict[str, Any]:
    ...

# delete_backup method usage example with argument unpacking

kwargs: DeleteBackupRequestRequestTypeDef = {  # (1)
    "BackupId": ...,
}

parent.delete_backup(**kwargs)

1. See DeleteBackupRequestRequestTypeDef

delete_server

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance).

Type annotations and code completion for boto3.client("opsworkscm").delete_server method. boto3 documentation

# delete_server method definition

def delete_server(
    self,
    *,
    ServerName: str,
) -> dict[str, Any]:
    ...

# delete_server method usage example with argument unpacking

kwargs: DeleteServerRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
}

parent.delete_server(**kwargs)

1. See DeleteServerRequestRequestTypeDef

describe_account_attributes

Describes your OpsWorks-CM account attributes.

Type annotations and code completion for boto3.client("opsworkscm").describe_account_attributes method. boto3 documentation

# describe_account_attributes method definition

def describe_account_attributes(
    self,
) -> DescribeAccountAttributesResponseTypeDef:  # (1)
    ...

1. See DescribeAccountAttributesResponseTypeDef

describe_backups

Describes backups.

Type annotations and code completion for boto3.client("opsworkscm").describe_backups method. boto3 documentation

# describe_backups method definition

def describe_backups(
    self,
    *,
    BackupId: str = ...,
    ServerName: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeBackupsResponseTypeDef:  # (1)
    ...

1. See DescribeBackupsResponseTypeDef

# describe_backups method usage example with argument unpacking

kwargs: DescribeBackupsRequestRequestTypeDef = {  # (1)
    "BackupId": ...,
}

parent.describe_backups(**kwargs)

1. See DescribeBackupsRequestRequestTypeDef

describe_events

Describes events for a specified server.

Type annotations and code completion for boto3.client("opsworkscm").describe_events method. boto3 documentation

# describe_events method definition

def describe_events(
    self,
    *,
    ServerName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeEventsResponseTypeDef:  # (1)
    ...

1. See DescribeEventsResponseTypeDef

# describe_events method usage example with argument unpacking

kwargs: DescribeEventsRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
}

parent.describe_events(**kwargs)

1. See DescribeEventsRequestRequestTypeDef

describe_node_association_status

Returns the current status of an existing association or disassociation request.

Type annotations and code completion for boto3.client("opsworkscm").describe_node_association_status method. boto3 documentation

# describe_node_association_status method definition

def describe_node_association_status(
    self,
    *,
    NodeAssociationStatusToken: str,
    ServerName: str,
) -> DescribeNodeAssociationStatusResponseTypeDef:  # (1)
    ...

1. See DescribeNodeAssociationStatusResponseTypeDef

# describe_node_association_status method usage example with argument unpacking

kwargs: DescribeNodeAssociationStatusRequestRequestTypeDef = {  # (1)
    "NodeAssociationStatusToken": ...,
    "ServerName": ...,
}

parent.describe_node_association_status(**kwargs)

1. See DescribeNodeAssociationStatusRequestRequestTypeDef

describe_servers

Lists all configuration management servers that are identified with your account.

Type annotations and code completion for boto3.client("opsworkscm").describe_servers method. boto3 documentation

# describe_servers method definition

def describe_servers(
    self,
    *,
    ServerName: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeServersResponseTypeDef:  # (1)
    ...

1. See DescribeServersResponseTypeDef

# describe_servers method usage example with argument unpacking

kwargs: DescribeServersRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
}

parent.describe_servers(**kwargs)

1. See DescribeServersRequestRequestTypeDef

disassociate_node

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.

Type annotations and code completion for boto3.client("opsworkscm").disassociate_node method. boto3 documentation

# disassociate_node method definition

def disassociate_node(
    self,
    *,
    ServerName: str,
    NodeName: str,
    EngineAttributes: Sequence[EngineAttributeTypeDef] = ...,  # (1)
) -> DisassociateNodeResponseTypeDef:  # (2)
    ...

1. See EngineAttributeTypeDef
2. See DisassociateNodeResponseTypeDef

# disassociate_node method usage example with argument unpacking

kwargs: DisassociateNodeRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
    "NodeName": ...,
}

parent.disassociate_node(**kwargs)

1. See DisassociateNodeRequestRequestTypeDef

export_server_engine_attribute

Exports a specified server engine attribute as a base64-encoded string.

Type annotations and code completion for boto3.client("opsworkscm").export_server_engine_attribute method. boto3 documentation

# export_server_engine_attribute method definition

def export_server_engine_attribute(
    self,
    *,
    ExportAttributeName: str,
    ServerName: str,
    InputAttributes: Sequence[EngineAttributeTypeDef] = ...,  # (1)
) -> ExportServerEngineAttributeResponseTypeDef:  # (2)
    ...

1. See EngineAttributeTypeDef
2. See ExportServerEngineAttributeResponseTypeDef

# export_server_engine_attribute method usage example with argument unpacking

kwargs: ExportServerEngineAttributeRequestRequestTypeDef = {  # (1)
    "ExportAttributeName": ...,
    "ServerName": ...,
}

parent.export_server_engine_attribute(**kwargs)

1. See ExportServerEngineAttributeRequestRequestTypeDef

list_tags_for_resource

Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

restore_server

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state.

Type annotations and code completion for boto3.client("opsworkscm").restore_server method. boto3 documentation

# restore_server method definition

def restore_server(
    self,
    *,
    BackupId: str,
    ServerName: str,
    InstanceType: str = ...,
    KeyPair: str = ...,
) -> RestoreServerResponseTypeDef:  # (1)
    ...

1. See RestoreServerResponseTypeDef

# restore_server method usage example with argument unpacking

kwargs: RestoreServerRequestRequestTypeDef = {  # (1)
    "BackupId": ...,
    "ServerName": ...,
}

parent.restore_server(**kwargs)

1. See RestoreServerRequestRequestTypeDef

start_maintenance

Manually starts server maintenance.

Type annotations and code completion for boto3.client("opsworkscm").start_maintenance method. boto3 documentation

# start_maintenance method definition

def start_maintenance(
    self,
    *,
    ServerName: str,
    EngineAttributes: Sequence[EngineAttributeTypeDef] = ...,  # (1)
) -> StartMaintenanceResponseTypeDef:  # (2)
    ...

1. See EngineAttributeTypeDef
2. See StartMaintenanceResponseTypeDef

# start_maintenance method usage example with argument unpacking

kwargs: StartMaintenanceRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
}

parent.start_maintenance(**kwargs)

1. See StartMaintenanceRequestRequestTypeDef

tag_resource

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes specified tags from an AWS OpsWorks-CM server or backup.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_server

Updates settings for a server.

Type annotations and code completion for boto3.client("opsworkscm").update_server method. boto3 documentation

# update_server method definition

def update_server(
    self,
    *,
    ServerName: str,
    DisableAutomatedBackup: bool = ...,
    BackupRetentionCount: int = ...,
    PreferredMaintenanceWindow: str = ...,
    PreferredBackupWindow: str = ...,
) -> UpdateServerResponseTypeDef:  # (1)
    ...

1. See UpdateServerResponseTypeDef

# update_server method usage example with argument unpacking

kwargs: UpdateServerRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
}

parent.update_server(**kwargs)

1. See UpdateServerRequestRequestTypeDef

update_server_engine_attributes

Updates engine-specific attributes on a specified server.

Type annotations and code completion for boto3.client("opsworkscm").update_server_engine_attributes method. boto3 documentation

# update_server_engine_attributes method definition

def update_server_engine_attributes(
    self,
    *,
    ServerName: str,
    AttributeName: str,
    AttributeValue: str = ...,
) -> UpdateServerEngineAttributesResponseTypeDef:  # (1)
    ...

1. See UpdateServerEngineAttributesResponseTypeDef

# update_server_engine_attributes method usage example with argument unpacking

kwargs: UpdateServerEngineAttributesRequestRequestTypeDef = {  # (1)
    "ServerName": ...,
    "AttributeName": ...,
}

parent.update_server_engine_attributes(**kwargs)

1. See UpdateServerEngineAttributesRequestRequestTypeDef

get_paginator

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

• client.get_paginator("describe_backups") -> DescribeBackupsPaginator
• client.get_paginator("describe_events") -> DescribeEventsPaginator
• client.get_paginator("describe_servers") -> DescribeServersPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator

get_waiter

Type annotations and code completion for boto3.client("opsworkscm").get_waiter method with overloads.

• client.get_waiter("node_associated") -> NodeAssociatedWaiter