AlexaForBusinessClient#
Index > AlexaForBusiness > AlexaForBusinessClient
Auto-generated documentation for AlexaForBusiness type annotations stubs module mypy-boto3-alexaforbusiness.
AlexaForBusinessClient#
Type annotations and code completion for boto3.client("alexaforbusiness").
boto3 documentation
# AlexaForBusinessClient usage example
from boto3.session import Session
from mypy_boto3_alexaforbusiness.client import AlexaForBusinessClient
def get_alexaforbusiness_client() -> AlexaForBusinessClient:
return Session().client("alexaforbusiness")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("alexaforbusiness").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("alexaforbusiness")
try:
do_something(client)
except (
client.exceptions.AlreadyExistsException,
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.DeviceNotRegisteredException,
client.exceptions.InvalidCertificateAuthorityException,
client.exceptions.InvalidDeviceException,
client.exceptions.InvalidSecretsManagerResourceException,
client.exceptions.InvalidServiceLinkedRoleStateException,
client.exceptions.InvalidUserStatusException,
client.exceptions.LimitExceededException,
client.exceptions.NameInUseException,
client.exceptions.NotFoundException,
client.exceptions.ResourceAssociatedException,
client.exceptions.ResourceInUseException,
client.exceptions.SkillNotLinkedException,
client.exceptions.UnauthorizedException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_alexaforbusiness.client import Exceptions
def handle_error(exc: Exceptions.AlreadyExistsException) -> None:
...Methods#
approve_skill#
Associates a skill with the organization under the customer's AWS account.
Type annotations and code completion for boto3.client("alexaforbusiness").approve_skill method.
boto3 documentation
# approve_skill method definition
def approve_skill(
self,
*,
SkillId: str,
) -> Dict[str, Any]:
...# approve_skill method usage example with argument unpacking
kwargs: ApproveSkillRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.approve_skill(**kwargs)associate_contact_with_address_book#
Associates a contact with a given address book.
Type annotations and code completion for boto3.client("alexaforbusiness").associate_contact_with_address_book method.
boto3 documentation
# associate_contact_with_address_book method definition
def associate_contact_with_address_book(
self,
*,
ContactArn: str,
AddressBookArn: str,
) -> Dict[str, Any]:
...# associate_contact_with_address_book method usage example with argument unpacking
kwargs: AssociateContactWithAddressBookRequestRequestTypeDef = { # (1)
"ContactArn": ...,
"AddressBookArn": ...,
}
parent.associate_contact_with_address_book(**kwargs)associate_device_with_network_profile#
Associates a device with the specified network profile.
Type annotations and code completion for boto3.client("alexaforbusiness").associate_device_with_network_profile method.
boto3 documentation
# associate_device_with_network_profile method definition
def associate_device_with_network_profile(
self,
*,
DeviceArn: str,
NetworkProfileArn: str,
) -> Dict[str, Any]:
...# associate_device_with_network_profile method usage example with argument unpacking
kwargs: AssociateDeviceWithNetworkProfileRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
"NetworkProfileArn": ...,
}
parent.associate_device_with_network_profile(**kwargs)associate_device_with_room#
Associates a device with a given room.
Type annotations and code completion for boto3.client("alexaforbusiness").associate_device_with_room method.
boto3 documentation
# associate_device_with_room method definition
def associate_device_with_room(
self,
*,
DeviceArn: str = ...,
RoomArn: str = ...,
) -> Dict[str, Any]:
...# associate_device_with_room method usage example with argument unpacking
kwargs: AssociateDeviceWithRoomRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
}
parent.associate_device_with_room(**kwargs)associate_skill_group_with_room#
Associates a skill group with a given room.
Type annotations and code completion for boto3.client("alexaforbusiness").associate_skill_group_with_room method.
boto3 documentation
# associate_skill_group_with_room method definition
def associate_skill_group_with_room(
self,
*,
SkillGroupArn: str = ...,
RoomArn: str = ...,
) -> Dict[str, Any]:
...# associate_skill_group_with_room method usage example with argument unpacking
kwargs: AssociateSkillGroupWithRoomRequestRequestTypeDef = { # (1)
"SkillGroupArn": ...,
}
parent.associate_skill_group_with_room(**kwargs)associate_skill_with_skill_group#
Associates a skill with a skill group.
Type annotations and code completion for boto3.client("alexaforbusiness").associate_skill_with_skill_group method.
boto3 documentation
# associate_skill_with_skill_group method definition
def associate_skill_with_skill_group(
self,
*,
SkillId: str,
SkillGroupArn: str = ...,
) -> Dict[str, Any]:
...# associate_skill_with_skill_group method usage example with argument unpacking
kwargs: AssociateSkillWithSkillGroupRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.associate_skill_with_skill_group(**kwargs)associate_skill_with_users#
Makes a private skill available for enrolled users to enable on their devices.
Type annotations and code completion for boto3.client("alexaforbusiness").associate_skill_with_users method.
boto3 documentation
# associate_skill_with_users method definition
def associate_skill_with_users(
self,
*,
SkillId: str,
) -> Dict[str, Any]:
...# associate_skill_with_users method usage example with argument unpacking
kwargs: AssociateSkillWithUsersRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.associate_skill_with_users(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("alexaforbusiness").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("alexaforbusiness").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_address_book#
Creates an address book with the specified details.
Type annotations and code completion for boto3.client("alexaforbusiness").create_address_book method.
boto3 documentation
# create_address_book method definition
def create_address_book(
self,
*,
Name: str,
Description: str = ...,
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAddressBookResponseTypeDef: # (2)
...# create_address_book method usage example with argument unpacking
kwargs: CreateAddressBookRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_address_book(**kwargs)create_business_report_schedule#
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
Type annotations and code completion for boto3.client("alexaforbusiness").create_business_report_schedule method.
boto3 documentation
# create_business_report_schedule method definition
def create_business_report_schedule(
self,
*,
Format: BusinessReportFormatType, # (1)
ContentRange: BusinessReportContentRangeTypeDef, # (2)
ScheduleName: str = ...,
S3BucketName: str = ...,
S3KeyPrefix: str = ...,
Recurrence: BusinessReportRecurrenceTypeDef = ..., # (3)
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateBusinessReportScheduleResponseTypeDef: # (5)
...- See BusinessReportFormatType
- See BusinessReportContentRangeTypeDef
- See BusinessReportRecurrenceTypeDef
- See TagTypeDef
- See CreateBusinessReportScheduleResponseTypeDef
# create_business_report_schedule method usage example with argument unpacking
kwargs: CreateBusinessReportScheduleRequestRequestTypeDef = { # (1)
"Format": ...,
"ContentRange": ...,
}
parent.create_business_report_schedule(**kwargs)create_conference_provider#
Adds a new conference provider under the user's AWS account.
Type annotations and code completion for boto3.client("alexaforbusiness").create_conference_provider method.