Skip to content

DeadlineCloudClient#

Index > DeadlineCloud > DeadlineCloudClient

Auto-generated documentation for DeadlineCloud type annotations stubs module mypy-boto3-deadline.

DeadlineCloudClient#

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

# DeadlineCloudClient usage example

from boto3.session import Session
from mypy_boto3_deadline.client import DeadlineCloudClient

def get_deadline_client() -> DeadlineCloudClient:
    return Session().client("deadline")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("deadline")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_deadline.client import Exceptions

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

Methods#

associate_member_to_farm#

Assigns a farm membership level to a member.

Type annotations and code completion for boto3.client("deadline").associate_member_to_farm method. boto3 documentation

# associate_member_to_farm method definition

def associate_member_to_farm(
    self,
    *,
    farmId: str,
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (1)
    principalId: str,
    principalType: PrincipalTypeType,  # (2)
) -> Dict[str, Any]:
    ...
  1. See MembershipLevelType
  2. See PrincipalTypeType
# associate_member_to_farm method usage example with argument unpacking

kwargs: AssociateMemberToFarmRequestRequestTypeDef = {  # (1)
    "farmId": ...,
    "identityStoreId": ...,
    "membershipLevel": ...,
    "principalId": ...,
    "principalType": ...,
}

parent.associate_member_to_farm(**kwargs)
  1. See AssociateMemberToFarmRequestRequestTypeDef

associate_member_to_fleet#

Assigns a fleet membership level to a member.

Type annotations and code completion for boto3.client("deadline").associate_member_to_fleet method. boto3 documentation

# associate_member_to_fleet method definition

def associate_member_to_fleet(
    self,
    *,
    farmId: str,
    fleetId: str,
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (1)
    principalId: str,
    principalType: PrincipalTypeType,  # (2)
) -> Dict[str, Any]:
    ...
  1. See MembershipLevelType
  2. See PrincipalTypeType
# associate_member_to_fleet method usage example with argument unpacking

kwargs: AssociateMemberToFleetRequestRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "identityStoreId": ...,
    "membershipLevel": ...,
    "principalId": ...,
    "principalType": ...,
}

parent.associate_member_to_fleet(**kwargs)
  1. See AssociateMemberToFleetRequestRequestTypeDef

associate_member_to_job#

Assigns a job membership level to a member See also: AWS API Documentation.

Type annotations and code completion for boto3.client("deadline").associate_member_to_job method. boto3 documentation

# associate_member_to_job method definition

def associate_member_to_job(
    self,
    *,
    farmId: str,
    identityStoreId: str,
    jobId: str,
    membershipLevel: MembershipLevelType,  # (1)
    principalId: str,
    principalType: PrincipalTypeType,  # (2)
    queueId: str,
) -> Dict[str, Any]:
    ...
  1. See MembershipLevelType
  2. See PrincipalTypeType
# associate_member_to_job method usage example with argument unpacking

kwargs: AssociateMemberToJobRequestRequestTypeDef = {  # (1)
    "farmId": ...,
    "identityStoreId": ...,
    "jobId": ...,
    "membershipLevel": ...,
    "principalId": ...,
    "principalType": ...,
    "queueId": ...,
}

parent.associate_member_to_job(**kwargs)
  1. See AssociateMemberToJobRequestRequestTypeDef

associate_member_to_queue#

Assigns a queue membership level to a member See also: AWS API Documentation.

Type annotations and code completion for boto3.client("deadline").associate_member_to_queue method. boto3 documentation

# associate_member_to_queue method definition

def associate_member_to_queue(
    self,
    *,
    farmId: str,
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (1)
    principalId: str,
    principalType: PrincipalTypeType,  # (2)
    queueId: str,
) -> Dict[str, Any]:
    ...
  1. See MembershipLevelType
  2. See PrincipalTypeType
# associate_member_to_queue method usage example with argument unpacking

kwargs: AssociateMemberToQueueRequestRequestTypeDef = {  # (1)
    "farmId": ...,
    "identityStoreId": ...,
    "membershipLevel": ...,
    "principalId": ...,
    "principalType": ...,
    "queueId": ...,
}

parent.associate_member_to_queue(**kwargs)
  1. See AssociateMemberToQueueRequestRequestTypeDef

assume_fleet_role_for_read#

Get Amazon Web Services credentials from the fleet role.

Type annotations and code completion for boto3.client("deadline").assume_fleet_role_for_read method. boto3 documentation

# assume_fleet_role_for_read method definition

def assume_fleet_role_for_read(
    self,
    *,
    farmId: str,
    fleetId: str,
) -> AssumeFleetRoleForReadResponseTypeDef:  # (1)
    ...
  1. See AssumeFleetRoleForReadResponseTypeDef
# assume_fleet_role_for_read method usage example with argument unpacking

kwargs: AssumeFleetRoleForReadRequestRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
}

parent.assume_fleet_role_for_read(**kwargs)
  1. See AssumeFleetRoleForReadRequestRequestTypeDef

assume_fleet_role_for_worker#

Get credentials from the fleet role for a worker.

Type annotations and code completion for boto3.client("deadline").assume_fleet_role_for_worker method. boto3 documentation

# assume_fleet_role_for_worker method definition

def assume_fleet_role_for_worker(
    self,
    *,
    farmId: str,
    fleetId: str,
    workerId: str,
) -> AssumeFleetRoleForWorkerResponseTypeDef:  # (1)
    ...
  1. See AssumeFleetRoleForWorkerResponseTypeDef
# assume_fleet_role_for_worker method usage example with argument unpacking

kwargs: AssumeFleetRoleForWorkerRequestRequestTypeDef = {  # (1)
    "farmId": ...,
    "fleetId": ...,
    "workerId": ...,
}

parent.assume_fleet_role_for_worker(**kwargs)
  1. See AssumeFleetRoleForWorkerRequestRequestTypeDef

assume_queue_role_for_read#

Gets Amazon Web Services credentials from the queue role.

Type annotations and code completion for boto3.client("deadline").assume_queue_role_for_read method.