Alexa For Business

Removes a device from Alexa For Business.

See also: AWS API Documentation

Request Syntax

client.delete_device(
    DeviceArn='string'
)

type DeviceArn:

string

param DeviceArn:

[REQUIRED]

The ARN of the device for which to request details.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists all of the smart home appliances associated with a room.

See also: AWS API Documentation

Request Syntax

client.list_smart_home_appliances(
    RoomArn='string',
    MaxResults=123,
    NextToken='string'
)

type RoomArn:

string

param RoomArn:

[REQUIRED]

The room that the appliances are associated with.

type MaxResults:

integer

param MaxResults:

The maximum number of appliances to be return per paginated calls.

type NextToken:

string

param NextToken:

The tokens used for pagination.

rtype:

dict

returns:

Response Syntax

{
    'SmartHomeAppliances': [
        {
            'FriendlyName': 'string',
            'Description': 'string',
            'ManufacturerName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • SmartHomeAppliances (list) --

    The smart home appliances.

    • (dict) --

      A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

      • FriendlyName (string) --

        The friendly name of the smart home appliance.

      • Description (string) --

        The description of the smart home appliance.

      • ManufacturerName (string) --

        The name of the manufacturer of the smart home appliance.

  • NextToken (string) --

    The tokens used for pagination.

Adds a new conference provider under the user's AWS account.

See also: AWS API Documentation

Request Syntax

client.create_conference_provider(
    ConferenceProviderName='string',
    ConferenceProviderType='CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
    IPDialIn={
        'Endpoint': 'string',
        'CommsProtocol': 'SIP'|'SIPS'|'H323'
    },
    PSTNDialIn={
        'CountryCode': 'string',
        'PhoneNumber': 'string',
        'OneClickIdDelay': 'string',
        'OneClickPinDelay': 'string'
    },
    MeetingSetting={
        'RequirePin': 'YES'|'NO'|'OPTIONAL'
    },
    ClientRequestToken='string'
)

type ConferenceProviderName:

string

param ConferenceProviderName:

[REQUIRED]

The name of the conference provider.

type ConferenceProviderType:

string

param ConferenceProviderType:

[REQUIRED]

A string that represents a type within a list of predefined types.

type IPDialIn:

dict

param IPDialIn:

The IP endpoint and protocol for calling.

• Endpoint (string) -- [REQUIRED]

  The IP address.

• CommsProtocol (string) -- [REQUIRED]

  The protocol, including SIP, SIPS, and H323.

type PSTNDialIn:

dict

param PSTNDialIn:

The information for PSTN conferencing.

• CountryCode (string) -- [REQUIRED]

  The zip code.

• PhoneNumber (string) -- [REQUIRED]

  The phone number to call to join the conference.

• OneClickIdDelay (string) -- [REQUIRED]

  The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

• OneClickPinDelay (string) -- [REQUIRED]

  The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

type MeetingSetting:

dict

param MeetingSetting:

[REQUIRED]

The meeting settings for the conference provider.

• RequirePin (string) -- [REQUIRED]

  The values that indicate whether the pin is always required.

type ClientRequestToken:

string

param ClientRequestToken:

The request token of the client.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'ConferenceProviderArn': 'string'
}

Response Structure

• (dict) --

  • ConferenceProviderArn (string) --

    The ARN of the newly created conference provider.

Lists all categories in the Alexa skill store.

See also: AWS API Documentation

Request Syntax

client.list_skills_store_categories(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

The tokens used for pagination.

type MaxResults:

integer

param MaxResults:

The maximum number of categories returned per paginated calls.

rtype:

dict

returns:

Response Syntax

{
    'CategoryList': [
        {
            'CategoryId': 123,
            'CategoryName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • CategoryList (list) --

    The list of categories.

    • (dict) --

      The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.

      • CategoryId (integer) --

        The ID of the skill store category.

      • CategoryName (string) --

        The name of the skill store category.

  • NextToken (string) --

    The tokens used for pagination.

Lists conference providers under a specific AWS account.

See also: AWS API Documentation

Request Syntax

client.list_conference_providers(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

The tokens used for pagination.

type MaxResults:

integer

param MaxResults:

The maximum number of conference providers to be return per paginated calls.

rtype:

dict

returns:

Response Syntax

{
    'ConferenceProviders': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Type': 'CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
            'IPDialIn': {
                'Endpoint': 'string',
                'CommsProtocol': 'SIP'|'SIPS'|'H323'
            },
            'PSTNDialIn': {
                'CountryCode': 'string',
                'PhoneNumber': 'string',
                'OneClickIdDelay': 'string',
                'OneClickPinDelay': 'string'
            },
            'MeetingSetting': {
                'RequirePin': 'YES'|'NO'|'OPTIONAL'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ConferenceProviders (list) --

    The conference providers.

    • (dict) --

      An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.

      • Arn (string) --

        The ARN of the newly created conference provider.

      • Name (string) --

        The name of the conference provider.

      • Type (string) --

        The type of conference providers.

      • IPDialIn (dict) --

        The IP endpoint and protocol for calling.

        • Endpoint (string) --

          The IP address.

        • CommsProtocol (string) --

          The protocol, including SIP, SIPS, and H323.

      • PSTNDialIn (dict) --

        The information for PSTN conferencing.

        • CountryCode (string) --

          The zip code.

        • PhoneNumber (string) --

          The phone number to call to join the conference.

        • OneClickIdDelay (string) --

          The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

        • OneClickPinDelay (string) --

          The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

      • MeetingSetting (dict) --

        The meeting settings for the conference provider.

        • RequirePin (string) --

          The values that indicate whether the pin is always required.

  • NextToken (string) --

    The tokens used for pagination.

Associates a skill with a skill group.

See also: AWS API Documentation

Request Syntax

client.associate_skill_with_skill_group(
    SkillGroupArn='string',
    SkillId='string'
)

type SkillGroupArn:

string

param SkillGroupArn:

The ARN of the skill group to associate the skill to.

type SkillId:

string

param SkillId:

[REQUIRED]

The unique identifier of the skill.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Links a user's account to a third-party skill provider. If this API is called by an assumed IAM role, the skill being linked must be a private skill, and the skill must be owned by the AWS account that assumed the IAM role.

See also: AWS API Documentation

Request Syntax

client.put_skill_authorization(
    AuthorizationResult={
        'string': 'string'
    },
    SkillId='string',
    RoomArn='string'
)

type AuthorizationResult:

dict

param AuthorizationResult:

[REQUIRED]

The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.

• (string) --

  • (string) --

type SkillId:

string

param SkillId:

[REQUIRED]

The unique identifier of a skill.

type RoomArn:

string

param RoomArn:

The room that the skill is authorized for.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Sets the conference preferences on a specific conference provider at the account level.

See also: AWS API Documentation

Request Syntax

client.put_conference_preference(
    ConferencePreference={
        'DefaultConferenceProviderArn': 'string'
    }
)

type ConferencePreference:

dict

param ConferencePreference:

[REQUIRED]

The conference preference of a specific conference provider.

• DefaultConferenceProviderArn (string) --

  The ARN of the default conference provider.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Retrieves the existing conference preferences.

See also: AWS API Documentation

Request Syntax

client.get_conference_preference()

rtype:

dict

returns:

Response Syntax

{
    'Preference': {
        'DefaultConferenceProviderArn': 'string'
    }
}

Response Structure

• (dict) --

  • Preference (dict) --

    The conference preference.

    • DefaultConferenceProviderArn (string) --

      The ARN of the default conference provider.

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

See also: AWS API Documentation

Request Syntax

client.register_avs_device(
    ClientId='string',
    UserCode='string',
    ProductId='string',
    DeviceSerialNumber='string',
    AmazonId='string'
)

type ClientId:

string

param ClientId:

[REQUIRED]

The client ID of the OEM used for code-based linking authorization on an AVS device.

type UserCode:

string

param UserCode:

[REQUIRED]

The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

type ProductId:

string

param ProductId:

[REQUIRED]

The product ID used to identify your AVS device during authorization.

type DeviceSerialNumber:

string

param DeviceSerialNumber:

[REQUIRED]

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

type AmazonId:

string

param AmazonId:

[REQUIRED]

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

rtype:

dict

returns:

Response Syntax

{
    'DeviceArn': 'string'
}

Response Structure

• (dict) --

  • DeviceArn (string) --

    The ARN of the device.

Unlinks a third-party account from a skill.

See also: AWS API Documentation

Request Syntax

client.delete_skill_authorization(
    SkillId='string',
    RoomArn='string'
)

type SkillId:

string

param SkillId:

[REQUIRED]

The unique identifier of a skill.

type RoomArn:

string

param RoomArn:

The room that the skill is authorized for.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Deletes a conference provider.

See also: AWS API Documentation

Request Syntax

client.delete_conference_provider(
    ConferenceProviderArn='string'
)

type ConferenceProviderArn:

string

param ConferenceProviderArn:

[REQUIRED]

The ARN of the conference provider.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Forgets smart home appliances associated to a room.

See also: AWS API Documentation

Request Syntax

client.forget_smart_home_appliances(
    RoomArn='string'
)

type RoomArn:

string

param RoomArn:

[REQUIRED]

The room that the appliances are associated with.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Initiates the discovery of any smart home appliances associated with the room.

See also: AWS API Documentation

Request Syntax

client.start_smart_home_appliance_discovery(
    RoomArn='string'
)

type RoomArn:

string

param RoomArn:

[REQUIRED]

The room where smart home appliance discovery was initiated.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Disassociates a skill from a skill group.

See also: AWS API Documentation

Request Syntax

client.disassociate_skill_from_skill_group(
    SkillGroupArn='string',
    SkillId='string'
)

type SkillGroupArn:

string

param SkillGroupArn:

The unique identifier of a skill.

type SkillId:

string

param SkillId:

[REQUIRED]

The ARN of a skill group to associate to a skill.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates an existing conference provider's settings.

See also: AWS API Documentation

Request Syntax

client.update_conference_provider(
    ConferenceProviderArn='string',
    ConferenceProviderType='CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
    IPDialIn={
        'Endpoint': 'string',
        'CommsProtocol': 'SIP'|'SIPS'|'H323'
    },
    PSTNDialIn={
        'CountryCode': 'string',
        'PhoneNumber': 'string',
        'OneClickIdDelay': 'string',
        'OneClickPinDelay': 'string'
    },
    MeetingSetting={
        'RequirePin': 'YES'|'NO'|'OPTIONAL'
    }
)

type ConferenceProviderArn:

string

param ConferenceProviderArn:

[REQUIRED]

The ARN of the conference provider.

type ConferenceProviderType:

string

param ConferenceProviderType:

[REQUIRED]

The type of the conference provider.

type IPDialIn:

dict

param IPDialIn:

The IP endpoint and protocol for calling.

• Endpoint (string) -- [REQUIRED]

  The IP address.

• CommsProtocol (string) -- [REQUIRED]

  The protocol, including SIP, SIPS, and H323.

type PSTNDialIn:

dict

param PSTNDialIn:

The information for PSTN conferencing.

• CountryCode (string) -- [REQUIRED]

  The zip code.

• PhoneNumber (string) -- [REQUIRED]

  The phone number to call to join the conference.

• OneClickIdDelay (string) -- [REQUIRED]

  The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

• OneClickPinDelay (string) -- [REQUIRED]

  The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

type MeetingSetting:

dict

param MeetingSetting:

[REQUIRED]

The meeting settings for the conference provider.

• RequirePin (string) -- [REQUIRED]

  The values that indicate whether the pin is always required.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists all skills in the Alexa skill store by category.

See also: AWS API Documentation

Request Syntax

client.list_skills_store_skills_by_category(
    CategoryId=123,
    NextToken='string',
    MaxResults=123
)

type CategoryId:

integer

param CategoryId:

[REQUIRED]

The category ID for which the skills are being retrieved from the skill store.

type NextToken:

string

param NextToken:

The tokens used for pagination.

type MaxResults:

integer

param MaxResults:

The maximum number of skills returned per paginated calls.

rtype:

dict

returns:

Response Syntax

{
    'SkillsStoreSkills': [
        {
            'SkillId': 'string',
            'SkillName': 'string',
            'ShortDescription': 'string',
            'IconUrl': 'string',
            'SampleUtterances': [
                'string',
            ],
            'SkillDetails': {
                'ProductDescription': 'string',
                'InvocationPhrase': 'string',
                'ReleaseDate': 'string',
                'EndUserLicenseAgreement': 'string',
                'GenericKeywords': [
                    'string',
                ],
                'BulletPoints': [
                    'string',
                ],
                'NewInThisVersionBulletPoints': [
                    'string',
                ],
                'SkillTypes': [
                    'string',
                ],
                'Reviews': {
                    'string': 'string'
                },
                'DeveloperInfo': {
                    'DeveloperName': 'string',
                    'PrivacyPolicy': 'string',
                    'Email': 'string',
                    'Url': 'string'
                }
            },
            'SupportsLinking': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • SkillsStoreSkills (list) --

    The skill store skills.

    • (dict) --

      The detailed information about an Alexa skill.

      • SkillId (string) --

        The ARN of the skill.

      • SkillName (string) --

        The name of the skill.

      • ShortDescription (string) --

        Short description about the skill.

      • IconUrl (string) --

        The URL where the skill icon resides.

      • SampleUtterances (list) --

        Sample utterances that interact with the skill.

        • (string) --

      • SkillDetails (dict) --

        Information about the skill.

        • ProductDescription (string) --

          The description of the product.

        • InvocationPhrase (string) --

          The phrase used to trigger the skill.

        • ReleaseDate (string) --

          The date when the skill was released.

        • EndUserLicenseAgreement (string) --

          The URL of the end user license agreement.

        • GenericKeywords (list) --

          The generic keywords associated with the skill that can be used to find a skill.

          • (string) --

        • BulletPoints (list) --

          The details about what the skill supports organized as bullet points.

          • (string) --

        • NewInThisVersionBulletPoints (list) --

          The updates added in bullet points.

          • (string) --

        • SkillTypes (list) --

          The types of skills.

          • (string) --

        • Reviews (dict) --

          The list of reviews for the skill, including Key and Value pair.

          • (string) --

            • (string) --

        • DeveloperInfo (dict) --

          The details about the developer that published the skill.

          • DeveloperName (string) --

            The name of the developer.

          • PrivacyPolicy (string) --

            The URL of the privacy policy.

          • Email (string) --

            The email of the developer.

          • Url (string) --

            The website of the developer.

      • SupportsLinking (boolean) --

        Linking support for a skill.

  • NextToken (string) --

    The tokens used for pagination.

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

See also: AWS API Documentation

Request Syntax

client.reject_skill(
    SkillId='string'
)

type SkillId:

string

param SkillId:

[REQUIRED]

The unique identifier of the skill.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

See also: AWS API Documentation

Request Syntax

client.approve_skill(
    SkillId='string'
)

type SkillId:

string

param SkillId:

[REQUIRED]

The unique identifier of the skill.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Gets details about a specific conference provider.

See also: AWS API Documentation

Request Syntax

client.get_conference_provider(
    ConferenceProviderArn='string'
)

type ConferenceProviderArn:

string

param ConferenceProviderArn:

[REQUIRED]

The ARN of the newly created conference provider.

rtype:

dict

returns:

Response Syntax

{
    'ConferenceProvider': {
        'Arn': 'string',
        'Name': 'string',
        'Type': 'CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
        'IPDialIn': {
            'Endpoint': 'string',
            'CommsProtocol': 'SIP'|'SIPS'|'H323'
        },
        'PSTNDialIn': {
            'CountryCode': 'string',
            'PhoneNumber': 'string',
            'OneClickIdDelay': 'string',
            'OneClickPinDelay': 'string'
        },
        'MeetingSetting': {
            'RequirePin': 'YES'|'NO'|'OPTIONAL'
        }
    }
}

Response Structure

• (dict) --

  • ConferenceProvider (dict) --

    The conference provider.

    • Arn (string) --

      The ARN of the newly created conference provider.

    • Name (string) --

      The name of the conference provider.

    • Type (string) --

      The type of conference providers.

    • IPDialIn (dict) --

      The IP endpoint and protocol for calling.

      • Endpoint (string) --

        The IP address.

      • CommsProtocol (string) --

        The protocol, including SIP, SIPS, and H323.

    • PSTNDialIn (dict) --

      The information for PSTN conferencing.

      • CountryCode (string) --

        The zip code.

      • PhoneNumber (string) --

        The phone number to call to join the conference.

      • OneClickIdDelay (string) --

        The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

      • OneClickPinDelay (string) --

        The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

    • MeetingSetting (dict) --

      The meeting settings for the conference provider.

      • RequirePin (string) --

        The values that indicate whether the pin is always required.

{'Profile': {'AddressBookArn': 'string', 'IsDefault': 'boolean'}}

Gets the details of a room profile by profile ARN.

See also: AWS API Documentation

Request Syntax

client.get_profile(
    ProfileArn='string'
)

type ProfileArn:

string

param ProfileArn:

The ARN of the room profile for which to request details. Required.

rtype:

dict

returns:

Response Syntax

{
    'Profile': {
        'ProfileArn': 'string',
        'ProfileName': 'string',
        'IsDefault': True|False,
        'Address': 'string',
        'Timezone': 'string',
        'DistanceUnit': 'METRIC'|'IMPERIAL',
        'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
        'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
        'SetupModeDisabled': True|False,
        'MaxVolumeLimit': 123,
        'PSTNEnabled': True|False,
        'AddressBookArn': 'string'
    }
}

Response Structure

• (dict) --

  • Profile (dict) --

    The details of the room profile requested. Required.

    • ProfileArn (string) --

      The ARN of a room profile.

    • ProfileName (string) --

      The name of a room profile.

    • IsDefault (boolean) --

      Retrieves if the profile is default or not.

    • Address (string) --

      The address of a room profile.

    • Timezone (string) --

      The time zone of a room profile.

    • DistanceUnit (string) --

      The distance unit of a room profile.

    • TemperatureUnit (string) --

      The temperature unit of a room profile.

    • WakeWord (string) --

      The wake word of a room profile.

    • SetupModeDisabled (boolean) --

      The setup mode of a room profile.

    • MaxVolumeLimit (integer) --

      The max volume limit of a room profile.

    • PSTNEnabled (boolean) --

      The PSTN setting of a room profile.

    • AddressBookArn (string) --

      The ARN of the address book.

{'EnablementType': 'ENABLED | PENDING', 'SkillType': 'PUBLIC | PRIVATE | ALL'}

{'SkillSummaries': {'EnablementType': 'ENABLED | PENDING',
                    'SkillType': 'PUBLIC | PRIVATE'}}

Lists all enabled skills in a specific skill group.

See also: AWS API Documentation

Request Syntax

client.list_skills(
    SkillGroupArn='string',
    EnablementType='ENABLED'|'PENDING',
    SkillType='PUBLIC'|'PRIVATE'|'ALL',
    NextToken='string',
    MaxResults=123
)

type SkillGroupArn:

string

param SkillGroupArn:

The ARN of the skill group for which to list enabled skills. Required.

type EnablementType:

string

param EnablementType:

Whether the skill is enabled under the user's account, or if it requires linking to be used.

type SkillType:

string

param SkillType:

Whether the skill is publicly available or is a private skill.

type NextToken:

string

param NextToken:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

type MaxResults:

integer

param MaxResults:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

rtype:

dict

returns:

Response Syntax

{
    'SkillSummaries': [
        {
            'SkillId': 'string',
            'SkillName': 'string',
            'SupportsLinking': True|False,
            'EnablementType': 'ENABLED'|'PENDING',
            'SkillType': 'PUBLIC'|'PRIVATE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • SkillSummaries (list) --

    The list of enabled skills requested. Required.

    • (dict) --

      The summary of skills.

      • SkillId (string) --

        The ARN of the skill summary.

      • SkillName (string) --

        The name of the skill.

      • SupportsLinking (boolean) --

        Linking support for a skill.

      • EnablementType (string) --

        Whether the skill is enabled under the user's account, or if it requires linking to be used.

      • SkillType (string) --

        Whether the skill is publicly available or is a private skill.

  • NextToken (string) --

    The token returned to indicate that there is more data available.

{'Profiles': {'IsDefault': 'boolean'}}

Searches room profiles and lists the ones that meet a set of filter criteria.

See also: AWS API Documentation

Request Syntax

client.search_profiles(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ]
)

type NextToken:

string

param NextToken:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

type MaxResults:

integer

param MaxResults:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

type Filters:

list

param Filters:

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

• (dict) --

  A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

  • Key (string) -- [REQUIRED]

    The key of a filter.

  • Values (list) -- [REQUIRED]

    The values of a filter.

    • (string) --

type SortCriteria:

list

param SortCriteria:

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

• (dict) --

  An object representing a sort criteria.

  • Key (string) -- [REQUIRED]

    The sort key of a sort object.

  • Value (string) -- [REQUIRED]

    The sort value of a sort object.

rtype:

dict

returns:

Response Syntax

{
    'Profiles': [
        {
            'ProfileArn': 'string',
            'ProfileName': 'string',
            'IsDefault': True|False,
            'Address': 'string',
            'Timezone': 'string',
            'DistanceUnit': 'METRIC'|'IMPERIAL',
            'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
            'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER'
        },
    ],
    'NextToken': 'string',
    'TotalCount': 123
}

Response Structure

• (dict) --

  • Profiles (list) --

    The profiles that meet the specified set of filter criteria, in sort order.

    • (dict) --

      The data of a room profile.

      • ProfileArn (string) --

        The ARN of a room profile.

      • ProfileName (string) --

        The name of a room profile.

      • IsDefault (boolean) --

        Retrieves if the profile data is default or not.

      • Address (string) --

        The address of a room profile.

      • Timezone (string) --

        The timezone of a room profile.

      • DistanceUnit (string) --

        The distance unit of a room profile.

      • TemperatureUnit (string) --

        The temperature unit of a room profile.

      • WakeWord (string) --

        The wake word of a room profile.

  • NextToken (string) --

    The token returned to indicate that there is more data available.

  • TotalCount (integer) --

    The total number of room profiles returned.

{'IsDefault': 'boolean'}

Updates an existing room profile by room profile ARN.

See also: AWS API Documentation

Request Syntax

client.update_profile(
    ProfileArn='string',
    ProfileName='string',
    IsDefault=True|False,
    Timezone='string',
    Address='string',
    DistanceUnit='METRIC'|'IMPERIAL',
    TemperatureUnit='FAHRENHEIT'|'CELSIUS',
    WakeWord='ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
    SetupModeDisabled=True|False,
    MaxVolumeLimit=123,
    PSTNEnabled=True|False
)

type ProfileArn:

string

param ProfileArn:

The ARN of the room profile to update. Required.

type ProfileName:

string

param ProfileName:

The updated name for the room profile.

type IsDefault:

boolean

param IsDefault:

Sets the profile as default if selected. If this is missing, no update is done to the default status.

type Timezone:

string

param Timezone:

The updated timezone for the room profile.

type Address:

string

param Address:

The updated address for the room profile.

type DistanceUnit:

string

param DistanceUnit:

The updated distance unit for the room profile.

type TemperatureUnit:

string

param TemperatureUnit:

The updated temperature unit for the room profile.

type WakeWord:

string

param WakeWord:

The updated wake word for the room profile.

type SetupModeDisabled:

boolean

param SetupModeDisabled:

Whether the setup mode of the profile is enabled.

type MaxVolumeLimit:

integer

param MaxVolumeLimit:

The updated maximum volume limit for the room profile.

type PSTNEnabled:

boolean

param PSTNEnabled:

Whether the PSTN setting of the room profile is enabled.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --